{"repo":"BRIKEV/express-jsdoc-swagger","free":true,"listed":false,"github":"https://github.com/BRIKEV/express-jsdoc-swagger","clone":"git clone https://github.com/BRIKEV/express-jsdoc-swagger.git","description":"Swagger OpenAPI 3.x generator","language":"JavaScript","stars":224,"topics":["swagger","jsdoc","openapi","openapi-generator","openapi3","expressjs","express-jsdoc-swagger","swagger-generator","hacktoberfest"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"express-jsdoc-swagger With this library, you can document your express endpoints using swagger OpenAPI 3 Specification without writing YAML or JSON. You can write comments similar to jsdoc on each endpoint, and the dependecy is going to create the swagger UI. Table of Contents 1. Prerequisites 2. Installation 3. Basic Usage 4. Basic Examples - Advanced examples - Official docs 5. Validator 6. VSCode extension Prerequisites This library assumes you are using: 1. NodeJS 2. Express.js Installation Basic Usage Basic Examples 1. Basic configuration options. 2. Components definition 3. Endpoint which returns a Songs model array in the response. 3. Endpoint PUT with body and path params which returns a Songs model array in the response. 4. Basic endpoint definition with tags, params and basic authentication 5. Basic endpoint definition with code example for response body You can find more examples here, or visit our documentation. Validator We developed a new package works as a validator of your API endpoints and the documentation you create with this package. This package is express-oas-validator. Example Install using the node package registry: We have to wait until we have the full swagger schema to initiate the validator. You can check out this also in our example folder. You can visit our documentation. Contributors ✨ Briam Martinez Escobar 💻 Kevin Julián Martínez Escobar 💻 Heung-yeon Oh 💻 Sara Hernández 💻 Josep Servat 💻 Nick Dong 💻 Aleksander Stós 💻 Kjell Dankert 💻 jul","default_branch":null,"files":null,"tree":[],"storefront":"/r/BRIKEV","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/BRIKEV/express-jsdoc-swagger/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}