Skip to main content

image

Overview​

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.

Installation​

This is a Node.js module available through the npm, yarn and pnpm.

npm install --save-dev swagger-autogen

Update​

If you already have the module installed and want to update to the latest version, use the command:

npm install --save-dev swagger-autogen@latest