{"repo":"Surnet/swagger-jsdoc","free":true,"listed":false,"github":"https://github.com/Surnet/swagger-jsdoc","clone":"git clone https://github.com/Surnet/swagger-jsdoc.git","description":"Generates swagger/openapi specification based on jsDoc comments and YAML files.","language":"JavaScript","stars":1788,"topics":["swagger","jsdoc","swagger-jsdoc","openapi"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"swagger-jsdoc This library reads your JSDoc-annotated source code and generates an OpenAPI (Swagger) specification. Getting started Imagine having API files like these: The library will take the contents of @openapi (or @swagger ) with the following configuration: The resulting openapiSpecification will be a swagger tools-compatible (and validated) specification. System requirements - Node.js 20.x or higher You are viewing swagger-jsdoc v6 which is published in CommonJS module system. Installation Or Supported specifications - OpenAPI 3.x - Swagger 2 - AsyncAPI 2.0 Validation of swagger docs By default swagger-jsdoc tries to parse all docs to it's best capabilities. If you'd like to you can instruct an Error to be thrown instead if validation failed by setting the options flag failOnErrors to true . This is for instance useful if you want to verify that your swagger docs validate using a unit test. Documentation Click on the version you are using for further details: - 7.x - 6.x - 5.x","default_branch":null,"files":null,"tree":[],"storefront":"/r/Surnet","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Surnet/swagger-jsdoc/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."}