swaggest/swagger2-schema

Swagger 2.0 schema PHP mappings

Maintainers

Details

github.com/swaggest/php-swagger2-schema

Source

Issues

Installs: 2 262

Dependents: 1

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 0

Open Issues: 0

v0.2.6 2021-06-17 22:37 UTC

Requires

Requires (Dev)

MIT 41d46ba37d53dd232b196e1299b8c818c9c43e3d

  • Viacheslav Poturaev <vearutop.woop@gmail.com>

This package is auto-updated.

Last update: 2024-12-18 06:13:27 UTC

README

Build Status codecov

Access and validate OpenAPI 3.0 and Swagger 2.0 schemas from PHP.

Installation

composer require swaggest/swagger2-schema

Usage

OpenAPI 3.0

// Load schema
$json = json_decode(file_get_contents(__DIR__ . '/../../../spec/petstore-openapi3.json'));

// Import and validate
$schema = OpenAPI3Schema::import($json);

// Access data through PHP classes
$this->assertSame('Swagger Petstore', $schema->info->title);
$ops = $schema->paths['/pets']->getGetPutPostDeleteOptionsHeadPatchTraceValues();
$this->assertSame('List all pets', $ops['get']->summary);

$responseSchema = $ops['get']->responses[200]->content['application/json']->schema;
$this->assertSame('array', $responseSchema->type);

Swagger 2.0

// Load schema
$json = json_decode(file_get_contents(__DIR__ . '/../../spec/petstore-swagger.json'));

// Import and validate
$schema = SwaggerSchema::import($json);

// Access data through PHP classes
$this->assertSame('Swagger Petstore', $schema->info->title);