skills.rest
Mathews-Tom
Mathews-TomCOMMUNITY
Explore all skills by this author →
𝕏@tom_mathewsGitHub

api-docs-generator

Audit FastAPI endpoint documentation and generate OpenAPI annotations with examples.

310|45|Updated Feb 22, 2026
Search Tags:#pydantic#fastapi#openapi#docstrings#generate#api-documentation#response-codes
One-click install
npx skills add https://github.com/Mathews-Tom/praxis-skills --skill api-docs-generator-mathews-tom
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs-generator
Source: https://github.com/Mathews-Tom/praxis-skills/tree/main/skills/api-docs-generator
Command: npx skills add https://github.com/Mathews-Tom/praxis-skills --skill api-docs-generator-mathews-tom

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill audits and fills gaps in API documentation so endpoints are clearly described, include realistic examples, and document response codes and errors to reduce integration friction and runtime surprises.

Core Features & Use Cases

  • Documentation audit: Detects missing or placeholder docstrings, undocumented path/query/body parameters, and absent response code coverage.
  • Docstring and OpenAPI enhancements: Generates concise summaries, detailed descriptions, tags, and responses annotations suitable for FastAPI and other REST frameworks.
  • Model and example generation: Produces Pydantic Field examples, json_schema_extra model examples, and matching request/response pairs for Swagger/OpenAPI.
  • Use case: Improve a public FastAPI service's Swagger docs by adding parameter descriptions, realistic examples, 4xx/5xx error schemas, and consistent tag organization.

Quick Start

Ask the skill to audit the FastAPI application and generate enhanced docstrings, Pydantic model examples, response code documentation, and an OpenAPI improvement plan.

Frequently Asked Questions about api-docs-generator

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

FAQPage Schema
How do I generate realistic examples for FastAPI Pydantic models and OpenAPI docs?▼

To generate OpenAPI docs for FastAPI, audit your application to detect missing docstrings and parameters, then produce enhanced docstrings, Pydantic model examples, and response code annotations ready for integration.

What is the best way to audit and fill gaps in API documentation?▼

Auditing API documentation involves detecting missing placeholder docstrings, undocumented path/query/body parameters, and absent response code coverage, then generating concise summaries, descriptions, and OpenAPI annotations to reduce integration friction.

How do I document 4xx and 5xx error response codes in FastAPI?▼

Document 4xx and 5xx error response codes in FastAPI by auditing endpoints for absent response coverage and generating responses annotations with error schemas suitable for OpenAPI integration.

Can I use this to add tags and descriptions to existing REST API endpoints?▼

Yes, you can enhance existing REST API endpoints by generating concise summaries, detailed descriptions, consistent tag organization, and OpenAPI metadata suitable for FastAPI and other REST frameworks.

Why does my Swagger UI lack request and response examples for Pydantic models?▼

Swagger UI lacks examples when Pydantic models miss Field examples or json_schema_extra definitions; auditing the API and generating matching request/response pairs resolves this documentation gap.

Related Skills

Explore More Software Engineering Skills→
DemolinatorDemolinator
2

Enhance API Documentation

Generate docstrings, OpenAPI examples, and Pydantic model annotations for FastAPI endpoints.

Community
Advanced
QunnnnQunnnn

go-swagger

Generate Swagger API documentation from annotated Go source code using swaggo/swag patterns.

Community
Intermediate
saintgo7saintgo7

api-contract-testing-pattern

Validate FastAPI routes, response schemas, and status codes against a committed OpenAPI snapshot.

Community
Intermediate
xloxn69xloxn69
7

api-documentation-generator

Generate OpenAPI 3.0 YAML/JSON specifications for REST API endpoints.

Community
Basic