This module performs automatic construction of Swagger documentation. It can identify the endpoints and automatically capture methods such as get, post, put, and so on. It also identifies paths, routes, middlewares, response status codes, parameters in the path, header, query and body. It is possible to add information such as endpoint description, parameter description, schemas, security, among others using comments in code. At the end, it generates the .json file containing the Swagger format specification.
This is a Node.js module available through the npm.
$ npm install --save-dev swagger-autogenIf you're using CommonJS:
const swaggerAutogen = require('swagger-autogen')();Or if you're using ES modules:
import swaggerAutogen from 'swagger-autogen';Please refer to the documentation website on https://swagger-autogen.github.io.
Check the GitHub Releases page.
Due to the number of open issues and the lack of time to respond with quality, I've disabled the opening of issues for now. I'm still keeping my eyes on the project and I intend to prioritize the issues already open. Once I have closed a satisfactory number of issues, I will open it again. Thank you for understanding.
MIT License