skills.rest
sitharaj88
sitharaj88COMMUNITY
Explore all skills by this author →
GitHub

generate-api-doc

Generate Markdown or OpenAPI 3.0 YAML documentation from codebase route definitions.

1|Updated Mar 2, 2026
Search Tags:#developer tools#documentation#openapi#code generation#rest api#api documentation
One-click install
npx skills add https://github.com/sitharaj88/claude-skills --skill generate-api-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-api-doc
Source: https://github.com/sitharaj88/claude-skills/tree/main/skills/generate-api-doc
Command: npx skills add https://github.com/sitharaj88/claude-skills --skill generate-api-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive API reference documentation directly from your codebase, saving developers significant time and ensuring accuracy.

Core Features & Use Cases

  • Automated Endpoint Discovery: Scans code to find all API routes and their associated handlers.
  • Detailed Parameter & Schema Analysis: Extracts request/response details, including path/query parameters, headers, and body schemas.
  • Authentication & Validation Documentation: Identifies and documents authentication requirements and validation rules.
  • Example Generation: Creates realistic example requests and responses.
  • Use Case: After implementing a new set of API endpoints in your backend framework (e.g., Express, FastAPI), use this Skill to instantly generate a Markdown or OpenAPI specification for your API documentation.

Quick Start

Use the generate-api-doc skill to create markdown documentation for all API endpoints in the project and save it to 'api-docs.md'.

Frequently Asked Questions about generate-api-doc

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

FAQPage Schema
How do I generate API documentation directly from my codebase?▼

Generate API documentation by analyzing route definitions, request/response types, and validation schemas within your codebase to automatically extract endpoint details and output Markdown or OpenAPI 3.0 YAML files.

Can I extract OpenAPI specifications from FastAPI and Express route definitions?▼

Yes, extracting OpenAPI specifications supports frameworks like Express, Next.js, Flask, FastAPI, Django, Go, and GraphQL by scanning code to identify routes, parameters, and response schemas.

How does automated API documentation handle authentication methods and validation rules?▼

Automated API documentation identifies and documents authentication requirements and validation rules by analyzing codebase schemas, extracting path parameters, query parameters, and request body details.

Does API documentation generation work with GraphQL and Go frameworks?▼

Yes, API documentation generation works with GraphQL and Go, alongside Express, Next.js, Flask, FastAPI, and Django, extracting detailed endpoint information and creating realistic example requests and responses.

What is the best way to create example requests and responses for REST API endpoints?▼

The best way to create example requests and responses is to scan existing REST API route handlers and validation schemas to automatically generate realistic examples formatted in Markdown or OpenAPI YAML.

Related Skills

Explore More Software Engineering Skills→
edulazaroedulazaro
12

lc:api-docs

Generate API documentation from Laravel routes, controllers, and form requests.

Community
Intermediate
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate
Vivekmano27Vivekmano27

api-docs-generator

Generate OpenAPI 3.0 documentation from NestJS and Django REST Framework codebases.

Community
Advanced
QunnnnQunnnn

go-swagger

Generate Swagger API documentation from annotated Go source code using swaggo/swag patterns.

Community
Intermediate