api-docs-generator

Featured

Audits and enhances FastAPI and REST API documentation: missing descriptions, response codes, examples, docstrings, Pydantic models, OpenAPI spec. Triggers on: "generate API docs", "document this API", "OpenAPI for", "FastAPI docs", "document endpoints", "swagger docs".

API & Backend 313 stars 46 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
83
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 | ## Prerequisites - Access to the API source code (route definitions, models) - Framework identification (FastAPI, Flask, Django REST, Express) ## Workflow ### Phase 1: Analyze Endpoints 1. **Inventory endpoints** — List all routes with HTTP method, path, handler function. 2. **Iden...

Details

Author
Mathews-Tom
Repository
Mathews-Tom/armory
Created
5 months ago
Last Updated
4 days ago
Language
Python
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category