api-docs-gen

Automated API Documentation from Source Code

Ditch the manual Swagger updates. This skill performs deep static analysis on your backend source code to generate professional-grade API documentation instantly. It maps routes, methods, schemas, and authentication requirements without requiring any manual entry or API keys.

What it does

• Multi-Framework Discovery: Supports Node.js (Express, Next.js, Hono, Koa), Python (FastAPI, Flask, Django REST), and more.
• Deep Schema Extraction: Infers request/response shapes from TypeScript interfaces, Zod schemas, Pydantic models, and JSDoc comments.
• Auth Mapping: Automatically identifies protected routes by detecting middleware like JWT, Passport, or FastAPI Dependencies.
• Dual Output Formats: Exports to valid OpenAPI 3.0 YAML for tooling or clean Markdown for READMEs and internal wikis.

Why use this skill?

Writing documentation is tedious and prone to drifting from reality. Unlike generic prompts, this skill uses specific heuristics to scan your file system, understand framework-specific routing patterns, and infer types from variable naming conventions when explicit types are missing. It produces structured, deployment-ready documentation that follows industry standards.

Supported Industry Tools

• Specifications: OpenAPI 3.0.3 (Swagger)
• Documentation: GitHub-flavored Markdown
• Validation: Compatible with Swagger UI, Redoc, and Postman