https://github.com/swagger-autogen/swagger-autogen
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 and parameters. At the end, it generates the .json file containing the Swagger format specification.
https://github.com/swagger-autogen/swagger-autogen
autogen autogeneration documentation openapi openapi3 swagger swagger-autogen swagger2
Last synced: 9 days ago
JSON representation
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 and parameters. At the end, it generates the .json file containing the Swagger format specification.
- Host: GitHub
- URL: https://github.com/swagger-autogen/swagger-autogen
- Owner: swagger-autogen
- License: mit
- Created: 2020-04-13T01:37:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-02T02:37:13.000Z (about 1 year ago)
- Last Synced: 2025-04-13T11:14:47.136Z (9 days ago)
- Topics: autogen, autogeneration, documentation, openapi, openapi3, swagger, swagger-autogen, swagger2
- Language: JavaScript
- Homepage: https://swagger-autogen.github.io
- Size: 889 KB
- Stars: 486
- Watchers: 4
- Forks: 65
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# swagger-autogen
## 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.
[](https://www.npmjs.com/package/swagger-autogen)
[](https://npmcharts.com/compare/swagger-autogen?minimal=true)
## Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Changelog](#changelog)
- [License](#license)
## Installation
This is a [Node.js](https://nodejs.org/en/) module available through the [npm](https://www.npmjs.com/).
```bash
$ npm install --save-dev swagger-autogen
```
If you're using CommonJS:
```js
const swaggerAutogen = require('swagger-autogen')();
```
Or if you're using ES modules:
```js
import swaggerAutogen from 'swagger-autogen';
```
## Documentation
Please refer to the documentation website on https://swagger-autogen.github.io.
## Changelog
Check the [GitHub Releases page](https://github.com/swagger-autogen/swagger-autogen/releases).
## Issues
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.
## License
[MIT](LICENSE) License