swagger-autogen
Advanced tools
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 th
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-autogen
If 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.
MIT License
FAQs
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 th
The npm package swagger-autogen receives a total of 68,398 weekly downloads. As such, swagger-autogen popularity was classified as popular.
We found that swagger-autogen demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.
Research
/Security News
Two npm packages masquerading as WhatsApp developer libraries include a kill switch that deletes all files if the phone number isn’t whitelisted.
Research
/Security News
Socket uncovered 11 malicious Go packages using obfuscated loaders to fetch and execute second-stage payloads via C2 domains.