Surnet/swagger-jsdoc

Health v2 · maintenance only

Adoption not part of the score

1788 stars · 228 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

A Node.js library that reads JSDoc-annotated source code and YAML files to generate OpenAPI (Swagger) specifications. It supports OpenAPI 3.x, Swagger 2, and AsyncAPI 2.0, with optional validation that throws on parsing errors.

Use cases

• generate openapi spec from jsdoc comments
• document express api routes with swagger annotations
• keep api docs in sync with code
• validate swagger docs in unit tests
• generate openapi 3.0 specification from yaml files
• document nodejs rest api

When to choose

• you want API documentation defined inline next to route handlers as JSDoc comments
• you need a validated OpenAPI/Swagger/AsyncAPI spec generated at build or runtime in Node.js
• you prefer documenting APIs in YAML blocks within source files

When to avoid

• you want to write OpenAPI specs by hand without code annotations
• your project is not JavaScript/Node.js based
• you need spec generation from other sources like TypeScript types or runtime request inspection

Facets

library · maturity active

api-documentation documentation parser developer-tools apis documentation web-development developer-tools openapi swagger jsdoc api-specification code-generation nodejs javascript

Member repositories

For agents

markdown · JSON · MCP: product_card(name="Surnet/swagger-jsdoc")