PHPackages                             luispabon/swagger-validator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. luispabon/swagger-validator

ActiveLibrary

luispabon/swagger-validator
===========================

Openapi v2 validation library for PHP

1.1.8(6y ago)117.3k1MITPHP

Since May 13Pushed 6y agoCompare

[ Source](https://github.com/luispabon/swagger-validator)[ Packagist](https://packagist.org/packages/luispabon/swagger-validator)[ RSS](/packages/luispabon-swagger-validator/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (13)Versions (19)Used By (0)

Note:
-----

[](#note)

This is a fork of WakeOnWeb's swagger validation component. It is a pretty good package, but fairly limited and very slow moving - it probably was made to serve the needs of WakeOnWeb's projects.

I intend to push this forward without the limitations of requiring upstream approval as there are many gaps in functionality and test coverage. This will be for v2.x.

Roadmap:
--------

[](#roadmap)

```
* Version 1.0.x (up to 1.0.4) is essentially the same as WakeOnWeb's.
* Version 1.1.x will contain any fixes beyond WakeOnWeb
* Version 2.0.x will go well beyond the original library with OA3 support, framework integrations etc

```

Original README:
================

[](#original-readme)

WakeOnWeb Swagger Validation Component [![Build Status](https://camo.githubusercontent.com/e0e4696e7018abc3f321ab2e9870b94cd1b90292a0b344f934180ccf2d598057/68747470733a2f2f7472617669732d63692e6f72672f57616b654f6e5765622f737761676765722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/WakeOnWeb/swagger)
=========================================================================================================================================================================================================================================================================================================================

[](#wakeonweb-swagger-validation-component-)

The WakeOnWeb Swagger Validation Component is an extensible component for validating API data using the [Swagger - OpenAPI](http://swagger.io) specification. The component supports both YAML and JSON Open API file formats. The component has very a small dependency set in order to be usable in different PHP frameworks.

The component uses:

- [PSR-6](http://www.php-fig.org/psr/psr-6/): For caching your OpenApi specification files
- [PSR-7](http://www.php-fig.org/psr/psr-7/): For processing HTTP messages (requests and responses)

Installation
------------

[](#installation)

The component can easily be installaed using

```
composer require wakeonweb/swagger

```

The component uses a JSON Schema validator, by default, the [justinrainbow/json-schema](https://github.com/justinrainbow/json-schema)is in the dev dependencies. If you intend to use the component in production you need to execute:

```
composer require justinrainbow/json-schema

```

Loading an OpenAPI specification file
-------------------------------------

[](#loading-an-openapi-specification-file)

The component supports both YAML and JSON OpenAPI format. Swagger files are loaded by the `SwaggerFactory`. The factory accepts a [PSR-6](http://www.php-fig.org/psr/psr-6/) `CacheItemPoolInterface`. If none provided it will use the `ArrayCachePool` provided by [cache/array-adapter](https://github.com/php-cache/array-adapter).

```
$factory = new SwaggerFactory();

// Register a YAML loader to load YAML Swagger files.
$factory->addLoader(new YamlLoader());

// Load the Swagger definition.
$swagger = $factory->buildFrom('/path/to/swagger/file.yml');
```

Executing this code will result in retrieving a tree representation of the specification into an instance of a `Swagger`document. At the moment, the cache contains the instance of the `Swagger` document.

Creating the a content validator
--------------------------------

[](#creating-the-a-content-validator)

Content validation in the component is based on JSON Schema Validation. The OpenAPI Specification handles much more than this. For example it allows to define query string parameters or the format of any HTTP Headers. The component supports all kind of validation.

Content validators are used to validate the content of a request or a response. Any content validator must implement the `ContentValidatorInterface` and should be registered into an instance of a `ContentValidator`. The resulting instance can be used into an instance of a `SwaggerValidator`.

```
// Create a content validator that validates requests and responses bodies.
$contentValidator = new ContentValidator();

// Register a specific content validator that handle "application/json".
$contentValidator->registerContentValidator(new JustinRainbowJsonSchemaValidator());
```

Validating a response
---------------------

[](#validating-a-response)

Validating response makes sense only for testing... As you are supposed to have valid code respectfull of your interface agreements in production!

```
// Create the validator and register the content validator.
$validator = new SwaggerValidator($swagger);
$validator->registerResponseValidator($contentValidator);

// Sample with Symfony Response....
$response = new Response(...);

$psr7Factory = new DiactorosFactory();

// Converts the response to a PRS-7 compliant format.
$response = $psr7Factory->createResponse($response);

try {
    // Validates the response against the required specification.
    $validator->validateResponseFor($response, PathItem::METHOD_GET, '/api/resource', 200);
} catch (SwaggerValidatorException $e) {
    // display $e message.
}
```

Validating a request
--------------------

[](#validating-a-request)

Validating response makes sense only for testing... As you are supposed to have valid code respectfull of your interface agreements in production!

```
// Create the validator and register the content validator.
$validator = new SwaggerValidator($swagger);
$validator->registerRequestValidator($contentValidator);

// Sample with Symfony Response....
$request = new Request(...);

$psr7Factory = new DiactorosFactory();

// Converts the response to a PRS-7 compliant format.
$request = $psr7Factory->createRequest($request);

try {
    // Validates the request against the required specification.
    $validator->validateRequestFor($request, PathItem::METHOD_GET, '/api/resource');
} catch (SwaggerValidatorException $e) {
    // display $e message.
}
```

Complete sample
---------------

[](#complete-sample)

The following sample code demonstrates a complete usage of the component.

```