swagger-endpoint-validator
v4.1.0
Published
A validator of API endpoints to check that input and output match with the swagger specification for the API
Downloads
515
Readme
swagger-endpoint-validator
A validator of API endpoints to check that input and/or output match with the swagger specification for the API.
This is based on express-swagger-generator, so it is important that each endpoints is properly documented so that the library can do the validation.
Installation
npm install --save swagger-endpoint-validator
Methods
init(app: ExpressApp, options: ConfigFile)
await validator.init(app, options);
where:
app
is the Express app instance.options
is the configuration object used by the validator.
TO DO!
Improve this doc.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!