api-docs-generator
Installation
SKILL.md
API Docs Generator
Audits API endpoint documentation for completeness, generates enhanced docstrings with proper parameter descriptions and examples, documents all response codes, and produces Pydantic model examples — bridging the gap between auto-generated OpenAPI specs and genuinely useful API documentation.
Reference Files
| File | Contents | Load When |
|---|---|---|
references/fastapi-patterns.md |
FastAPI-specific documentation patterns, Path/Query/Body parameter docs | FastAPI endpoint |
references/example-generation.md |
Creating realistic field examples, model_config patterns | Example values needed |
references/response-codes.md |
Standard HTTP response documentation, error response schemas | Response documentation needed |
references/openapi-enhancement.md |
OpenAPI spec enrichment, tag organization, schema documentation | OpenAPI spec review |