gossi/swagger

A php library to manipulate swagger specifications

swagger

, _(*1)

A php library to manipulate swagger/Open API specifications., _(*2)

Installation

composer require gossi/swagger

Usage

Read an api.json file:, _(*3)

$swagger = Swagger::fromFile('api.json');

// or

$swagger = new Swagger($array);

Collections

There are two major collections: Paths and Definitions. The API is similar for both:, _(*4)

$paths = $swagger->getPaths();
$p = new Path('/user');

// adding
$paths->add($p);

// retrieving
if ($paths->has('/user') || $paths->contains($p)) {
    $path = $paths->get('/user');
}

// removing
$paths->remove('/user');

// iterating
foreach ($paths as $path) {
    // do sth with $path
}

Other collections are: Headers, Parameters, Responses and SecurityDefinitions., _(*5)

Models

There are a lot of models, e.g. the mentioned Path above. The API is well written, so it works with the auto-completion of your IDE. It is straight forward and uses the same naming scheme as the OpenAPI specification., _(*6)

Contributing

Feel free to fork and submit a pull request (don't forget the tests) and I am happy to merge., _(*7)