Enhance API Documentation

What problem does it solve?

This Skill automates the augmentation of API documentation for FastAPI projects by adding comprehensive docstrings, OpenAPI examples, and precise response models to endpoints, improving developer onboarding and API usability.

Core Features & Use Cases

• Docstrings: Generate detailed endpoint docstrings describing behavior, inputs, outputs, authentication, and error responses.
• OpenAPI Enrichment: Add example requests/responses and schema details to OpenAPI docs.
• Model Annotations: Extend Pydantic models with example values to improve schema clarity.
• Use Case: A team adds consistent, fully-documented endpoints across a FastAPI service to reduce onboarding time for new developers.

Quick Start

Run the enhancement script on your FastAPI project to automatically generate docstrings, enrich OpenAPI with examples, and update model annotations.