fastapi-api-docs

What problem does it solve?

This Skill helps ensure that your FastAPI application's API documentation is complete and accurate, preventing issues caused by missing descriptions or incorrect schema definitions.

Core Features & Use Cases

• Route Validation: Checks if FastAPI routes have necessary documentation elements like docstrings and response models.
• Schema Completeness: Verifies the OpenAPI schema for missing descriptions, parameters, and response codes.
• Model Validation: Inspects Pydantic models for field descriptions and examples.
• Use Case: Before deploying a new API version, use this Skill to automatically audit all endpoints and their associated documentation, ensuring a professional and user-friendly API.

Quick Start

Run the fastapi-api-docs skill to validate the documentation for the FastAPI application in the current directory.