api-documentation-generator

Generate OpenAPI 3.0 documentation from API route definitions in code.

Updated Oct 27, 2025
One-click install
npx skills add https://github.com/CrazyDubya/claude-skills --skill api-documentation-generator-crazydubya
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documentation-generator
Source: https://github.com/CrazyDubya/claude-skills/tree/main/api-documentation-generator
Command: npx skills add https://github.com/CrazyDubya/claude-skills --skill api-documentation-generator-crazydubya

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates OpenAPI/Swagger documentation generation from API route files to keep specs up-to-date.

Core Features & Use Cases

  • Route discovery: finds API route definitions across frameworks.
  • OpenAPI generation: builds path, schemas, and responses.
  • Template-based output: uses base templates to standardize docs.

Quick Start

Scan your codebase for routes and emit an openapi.yaml file in the project root.

Frequently Asked Questions about api-documentation-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate OpenAPI documentation from my REST API routes?

OpenAPI documentation generation automatically extracts HTTP methods, paths, parameters, and responses from your route definitions across frameworks like Express, FastAPI, Flask, NestJS, and Rails, then outputs a structured openapi.yaml or swagger.json file.

What frameworks does automatic route documentation support?

Route analysis works across Express, FastAPI, Flask, NestJS, Rails, and similar frameworks. The Skill scans your codebase for route definitions, extracts endpoint patterns, and maps them to OpenAPI 3.0 paths with proper HTTP methods and schemas.

Can I keep my OpenAPI documentation in sync with code changes?

Yes. By scanning route files directly, this approach generates documentation from live route definitions rather than manual specs, so your OpenAPI docs stay current as endpoints change without requiring separate updates.

How does route discovery extract parameters and request bodies?

The Skill analyzes route patterns to identify path parameters, query strings, and request bodies, then generates JSON Schema definitions from code models and integrates security schemes and authentication requirements into the OpenAPI output.

Does this work for APIs with authentication?

Yes. The documentation generation includes mapping of security schemes and authentication requirements extracted from your routes, embedding them into the OpenAPI specification for complete endpoint documentation.

What output format does the documentation generator produce?

The Skill outputs validated OpenAPI 3.0 specifications as openapi.yaml or swagger.json files placed in your project root, with example content and standardized formatting using template-based generation.