Download the PHP package twentytwo-labs/api-validator without Composer
On this page you can find all versions of the php package twentytwo-labs/api-validator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download twentytwo-labs/api-validator
More information about twentytwo-labs/api-validator
Files in twentytwo-labs/api-validator
Package api-validator
Short Description Validate PSR-7 Requests against an OpenAPI/Swagger2 Schema
License
Informations about the package api-validator
API Validator
This library provides a set of classes suited to describe a WebService based on the HTTP protocol.
It can validate PSR-7 Requests against a schema.
It's design is heavily inspired by the OpenAPI/Swagger2.0 specifications.
As of now, it only support the OpenAPi/Swagger2.0 specifications but we plan to support RAML 1.0 and API Elements (API Blueprint) in the future.
Dependencies
We rely on the justinrainbow/json-schema library to parse specification files and to validate requests and responses:
- Request's
headers
,query
,uri
andbody
parts. - Response
headers
andbody
parts.
Usage
Before you start
You will need to write a valid Swagger 2.0 file in order to use this library. Ensure that this file is valid using the Swagger Editor.
You can also validate your specifications using the Swagger 2.0 JSONSchema.
Validate a request
You can validate any PSR-7:
- Request implementing the
Psr\Http\Message\RequestInterface
interface. - Response implementing the
Psr\Http\Message\ResponseInterface
interface.
Working with Symfony HTTPFoundation Requests
You will need an adapter in order to validate symfony requests.
We recommend you to use the symfony/psr-http-message-bridge
Using the schema
You can navigate the TwentytwoLabs\ApiValidator\Schema
to meet other use cases.
Example:
All versions of api-validator with dependencies
ext-json Version *
psr/http-message Version ^2.0
psr/cache Version >=1.0
justinrainbow/json-schema Version ^5.0
rize/uri-template Version ^0.3