# 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, parameters in th

Latest version **2.23.7** (published 2023-10-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install swagger-autogen
pnpm add swagger-autogen
yarn add swagger-autogen
bun add swagger-autogen
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.23.7 |
| Published | 2023-10-28 |
| First published | 2020-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 341.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 507 |
| Author | Davi D. Baltar |
| Maintainers | davibaltar |
| Keywords | swagger, autogen, generated, automatically, documentation, swagger-autogen, auto, automatic, generator, generate, autogenerate, autogenerator, autogenerated, openapi |

## Links

- npm: https://www.npmjs.com/package/swagger-autogen
- Repository: https://github.com/swagger-autogen/swagger-autogen
- Homepage: https://swagger-autogen.github.io
- Issues: https://github.com/swagger-autogen/swagger-autogen/issues
- npm.io page: https://npm.io/package/swagger-autogen

## Dependencies (4)

- [glob](https://npm.io/package/glob.md) ^7.1.7
- [acorn](https://npm.io/package/acorn.md) ^7.4.1
- [json5](https://npm.io/package/json5.md) ^2.2.3
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 2.23.7 (latest) — 2023-10-28
- 2.23.6 — 2023-09-19
- 2.23.5 — 2023-07-15
- 2.23.4 — 2023-06-25
- 2.23.3 — 2023-06-24
- 2.23.2 — 2023-06-15
- 2.23.1 — 2023-02-10
- 2.23.0 — 2023-01-29
- 2.22.0 — 2022-09-22
- 2.21.10 — 2022-09-19
- 2.21.9 — 2022-09-18
- 2.21.8 — 2022-09-15
- 2.21.7 — 2022-09-14
- 2.21.6 — 2022-09-12
- 2.21.5 — 2022-07-06
- … 129 more at https://npm.io/package/swagger-autogen/versions

## 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.

[![NPM Version](http://img.shields.io/npm/v/swagger-autogen.svg?style=flat)](https://www.npmjs.com/package/swagger-autogen)
[![NPM Downloads](https://img.shields.io/npm/dm/swagger-autogen.svg?style=flat)](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).

## License

[MIT](LICENSE) License

---
_Source: https://npm.io/package/swagger-autogen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._