skills.rest
accolver
accolverCOMMUNITY
Explore all skills by this author →
Website𝕏@acolveGitHub

api-doc-generator

Extract endpoints, methods, parameters, and schemas from source code into Markdown and OpenAPI 3.0 JSON.

4|Updated Mar 6, 2026
Search Tags:#documentation#markdown#api#openapi#validation#endpoint#code-analysis
One-click install
npx skills add https://github.com/accolver/skill-maker --skill api-doc-generator-accolver
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-doc-generator
Source: https://github.com/accolver/skill-maker/tree/main/api-doc-generator
Command: npx skills add https://github.com/accolver/skill-maker --skill api-doc-generator-accolver

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documents an existing API by extracting endpoints, HTTP methods, parameters, authentication requirements, and error patterns from source code to create a reliable reference.

Core Features & Use Cases

  • Extracts endpoints, HTTP methods, path and query parameters, request and response schemas, authentication requirements, and error patterns from code.
  • Generates both human-readable Markdown API references and machine-readable OpenAPI 3.0 JSON specifications.
  • Ideal for documenting existing APIs in Express, FastAPI, Django, NestJS, and similar frameworks, including migration, onboarding, and API redesign scenarios.

Quick Start

Run the skill against your codebase to generate a Markdown API reference and an OpenAPI 3.0 JSON spec.

Frequently Asked Questions about api-doc-generator

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

FAQPage Schema
How do I generate API documentation from source code automatically?▼

You can generate API documentation by running this skill against your codebase to extract endpoints, HTTP methods, parameters, and schemas, producing both a Markdown reference and an OpenAPI 3.0 JSON specification.

What is the best way to create an OpenAPI 3.0 specification from an existing codebase?▼

The best way to create an OpenAPI 3.0 specification from an existing codebase is to analyze endpoint definitions and error patterns to output a machine-readable JSON file reflecting your current API structure.

Can I extract API endpoints and parameters from Express or FastAPI projects?▼

Yes, you can extract API endpoints and parameters from Express, FastAPI, Django, and NestJS projects to document authentication requirements and error handling patterns for migration or onboarding scenarios.

Does API documentation generation work for both Markdown and machine-readable formats?▼

API documentation generation works for both formats by extracting request and response schemas to produce a human-friendly Markdown API reference alongside a machine-readable OpenAPI 3.0 JSON specification.

When do I need to generate API documentation from code instead of writing it manually?▼

You need to generate API documentation from code instead of writing it manually during API migration, onboarding, or redesign scenarios to ensure your reference accurately reflects existing endpoints without manual synchronization errors.

Related Skills

Explore More Software Engineering Skills→
KimDoubleBKimDoubleB
10

generating-tests-from-code

Generate k6 load test scripts by analyzing API codebases.

Community
Advanced
Lautaro073Lautaro073

api-reference-documentation

Generates endpoints, models, and authentication details from OpenAPI 3.0 documents into Markdown-ready content.

Community
Intermediate
cjinzycjinzy
2

jin-cleanser

Analyze AI-generated code for slop patterns and generate a markdown report.

Community
Intermediate
henrybravohenrybravo

documentation-synthesis

Generate Markdown documentation from code comments and OpenAPI or GraphQL schemas.

Community
Advanced