Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 6.57 KB

README.md

File metadata and controls

65 lines (46 loc) · 6.57 KB

All Contributors

CI CD Maintainability Test Coverage

swagger-endpoint-validator

npm

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):

Kevin Julián Martínez Escobar
Kevin Julián Martínez Escobar

🐛 💻 📖 🤔 👀 ⚠️
Sara Hernández
Sara Hernández

🐛 💻
Irene Mateo Herrero
Irene Mateo Herrero

💻
Íñigo Marquínez Prado
Íñigo Marquínez Prado

🐛 💻 📖 🤔 🚧 👀 ⚠️
Ulises Gascón
Ulises Gascón

🐛 💻 📖 🤔 🚧 👀 ⚠️
David Miguel Yusta
David Miguel Yusta

💻 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!