api-contract-validator1.1.3 • Public • Published
This is a plugin for validating API response schemas against Swagger/OpenAPI definition.
Using the plugin is easy. Simply point the plugin to your Swagger 2.0 or OpenAPIv 3.0 file and add one line to your integration test to validate that your application adheres to its design contract.
- Asserts according to API definitions document
- Descriptive assertion failures
- Simple and concise usage
- Coverage report
How does it work?
The api-contract-validator transforms your API definition into a json-schema based on the provided API documentation file. Then whenever the
matchApiSchema assertion is called, it automatically extracts the method, path and status code from the response object returned by the API request that you invoked and validates the response object. Both the response headers and body are validated.
How to use?
> npm i --save-dev api-contract-validator
const matchApiSchema = chaiPlugin;const path = ;const expect use = ;// API definitions pathconst apiDefinitionsPath = path;// add as chai plugin;
const matchApiSchema = shouldPlugin;// API definitions pathconst apiDefinitionsPath = path;// add as should plugin;
Descriptive assertion failures
AssertionError: expected response to match API schema+ expected - actual"body":- "age": -1+ "age": "should be >= 0"+ "name": "should have required property""headers":- "x-expires-after":- "x-rate-limit": -5+ "x-expires-after": "should be string"+ "x-rate-limit": "should be >= 0"
By providing in the plugin options, the flag
reportCoverage:true, the plugin generates a report of all uncovered API definitions.
* API definitions coverage report *Uncovered API definitions found:*ROUTE* | *METHOD* | *STATUSES*/v2/pet | POST | 405/v2/pet | PUT | 400,404,405/v2/pet/findByStatus | GET | 200,400/v2/pet/findByTags | GET | 200,400/v2/pet/:petId | GET | 400,404/v2/pet/:petId | POST | 405/v2/pet/:petId | DELETE | 400,404/v2/pet/:petId/uploadImage | POST | 200
Supported request libraries
- more to come
* When using request-promise
resolveWithFullResponse:true must be added to the request options, in order to properly extract the request details
Supported assertion libraries
- more to come