# swagger-jsdoc

Node.js library that reads JSDoc-annotated source code and generates an OpenAPI or Swagger specification.


Source: https://findsoftware.frbit.cloud/swagger-jsdoc/
Last reviewed: 2026-11-16
Listed since: 2026-11-16

## Record

### Links

- repository: https://github.com/Surnet/swagger-jsdoc
- docs: https://github.com/Surnet/swagger-jsdoc/tree/v6/docs

### Identity

- status: active
- maintainer: Surnet
- maintainerType: unknown
- parent: unknown
- firstRelease: 2015
- hqCountry: unknown

### Kind

- category: backend
- hosting: node
- language: javascript
- runtime: node
- runtimeMin: node 20
- basedOn: unknown

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: unknown
- renderingModes: unknown
- installMethod: npm

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 6
- latestReleaseDate: 2026-05-22

### Adoption

- githubStargazers: 1790
- packagistDownloads: not applicable
- npmWeeklyDownloads: 1972153
- contributors: 63
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 9576
- dependentPackages: 404

### Sources

- name: https://raw.githubusercontent.com/Surnet/swagger-jsdoc/v6.3.0/README.md (read 2026-11-16)
- urls: https://api.github.com/repos/Surnet/swagger-jsdoc (read 2026-11-16)
- urls: https://raw.githubusercontent.com/Surnet/swagger-jsdoc/v6.3.0/README.md (read 2026-11-16)
- firstRelease: https://api.github.com/repos/Surnet/swagger-jsdoc/releases (read 2026-11-16)
- maintainer: https://api.github.com/users/Surnet (read 2026-11-16)
- language: https://api.github.com/repos/Surnet/swagger-jsdoc (read 2026-11-16)
- category: https://raw.githubusercontent.com/Surnet/swagger-jsdoc/v6.3.0/README.md (read 2026-11-16)
- runtime: https://raw.githubusercontent.com/Surnet/swagger-jsdoc/v6.3.0/README.md (read 2026-11-16)
- runtimeMin: https://raw.githubusercontent.com/Surnet/swagger-jsdoc/v6.3.0/README.md (read 2026-11-16)
- installMethod: https://raw.githubusercontent.com/Surnet/swagger-jsdoc/v6.3.0/README.md (read 2026-11-16)
- license: https://raw.githubusercontent.com/Surnet/swagger-jsdoc/v6.3.0/LICENSE (read 2026-11-16)
- licenseModel: https://raw.githubusercontent.com/Surnet/swagger-jsdoc/v6.3.0/LICENSE (read 2026-11-16)
- currentMajor: https://api.github.com/repos/Surnet/swagger-jsdoc/releases (read 2026-11-16)
- latestReleaseDate: https://api.github.com/repos/Surnet/swagger-jsdoc/releases (read 2026-11-16)
- githubStargazers: https://api.github.com/repos/Surnet/swagger-jsdoc (read 2026-11-16)
- contributors: https://api.github.com/repos/Surnet/swagger-jsdoc/contributors?per_page=1 (read 2026-11-16)
- npmWeeklyDownloads: https://api.npmjs.org/downloads/range/2026-11-01:2026-11-07/swagger-jsdoc (read 2026-11-16)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/swagger-jsdoc (read 2026-11-16)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/swagger-jsdoc (read 2026-11-16)

## Notes

swagger-jsdoc is a Node.js library that reads JSDoc-annotated JavaScript source code and generates an OpenAPI specification from it. A command line interface wraps the library and is available under the package name when installed globally.

The README lists OpenAPI, Swagger 2 and AsyncAPI as supported specifications. The [6.x documentation](https://github.com/Surnet/swagger-jsdoc/tree/v6/docs) gives the details for that line.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0
