fastapi-api-docs

Validate FastAPI route definitions and OpenAPI schema completeness.

Updated Jul 29, 2025
One-click install
npx skills add https://github.com/dieguscl/dotfiles --skill fastapi-api-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fastapi-api-docs
Source: https://github.com/dieguscl/dotfiles/tree/main/claude/skills/fastapi-api-docs
Command: npx skills add https://github.com/dieguscl/dotfiles --skill fastapi-api-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about fastapi-api-docs

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

FAQPage Schema
How do I validate FastAPI route definitions for missing docstrings?

To validate FastAPI route definitions, the skill scans your application to identify missing docstrings, response models, and incomplete OpenAPI schema elements, ensuring your API documentation is fully populated.

How do I check OpenAPI schema completeness for Pydantic models?

To check OpenAPI schema completeness, the skill inspects Pydantic models for missing field descriptions and examples, verifying that all schema parameters and response codes are properly defined.

Can I audit FastAPI documentation before deploying a new API version?

Yes, you can audit FastAPI documentation before deployment by running the skill against your current directory to automatically check endpoints, Pydantic models, and OpenAPI schemas for missing elements.

Does this skill work with Python-based FastAPI applications only?

Yes, this skill supports Python-based FastAPI applications and their associated Pydantic models, specifically validating the framework's generated OpenAPI schemas and route definitions.