api-documenter

name	api-documenter
description	Generate API documentation: OpenAPI 3.1 specs, interactive docs with Swagger/Redoc, SDK generation, and JSDoc/TSDoc extraction.
metadata	{"thinkfleetbot":{"emoji":"📖","requires":{"anyBins":["npx","node"]}}}

API Documentation

Generate and maintain API documentation from code and OpenAPI specs.

OpenAPI Spec Validation

# Validate an OpenAPI spec
npx @apidevtools/swagger-cli validate openapi.yaml

# Bundle split spec files into one
npx @apidevtools/swagger-cli bundle openapi.yaml -o openapi-bundled.yaml

Interactive Docs

Swagger UI

# Serve Swagger UI locally
npx @redocly/cli preview openapi.yaml

# Or with Docker
docker run -p 8080:8080 -e SWAGGER_JSON=/spec/openapi.yaml -v $(pwd):/spec swaggerapi/swagger-ui

Redoc

# Generate static HTML docs
npx @redocly/cli build-docs openapi.yaml -o docs.html

# Preview with hot reload
npx @redocly/cli preview-docs openapi.yaml

Generate OpenAPI from Code

Express/Node.js with swagger-jsdoc

# Install
npm install swagger-jsdoc swagger-ui-express

# Generate spec from JSDoc annotations
node -e "
const swaggerJsdoc = require('swagger-jsdoc');
const spec = swaggerJsdoc({
  definition: { openapi: '3.1.0', info: { title: 'My API', version: '1.0.0' } },
  apis: ['./src/routes/*.ts'],
});
console.log(JSON.stringify(spec, null, 2));
" > openapi.json