generate-api-code-documentation

Scan FastAPI controllers, services, and models to generate an APIs.md reference.

11|3|Updated Aug 31, 2025
One-click install
npx skills add https://github.com/tonehq/tone --skill generate-api-code-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-api-code-documentation
Source: https://github.com/tonehq/tone/tree/main/.claude/skills/generate-api-code-documentation
Command: npx skills add https://github.com/tonehq/tone --skill generate-api-code-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Parses a FastAPI codebase (controllers, services, and models) to generate a structured APIs.md living reference that documents both file-level content and per-route details.

Core Features & Use Cases

  • File-level summaries for each Python module (controllers, services, models)
  • Per-route API documentation with request/response details, schemas, and code traces
  • Writes or updates APIs.md in the project root and supports dual edition structures (core/ ee/)
  • Maintains compatibility with existing manual notes when re-generating

Quick Start

Run the skill against your FastAPI project to generate or refresh APIs.md.

Frequently Asked Questions about generate-api-code-documentation

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

FAQPage Schema
How do I auto-generate API documentation from a FastAPI project?

Auto-generate API documentation from a FastAPI project by scanning its controllers, services, and models to produce a structured APIs.md reference with file-level summaries and per-route details.

Can I trace FastAPI routes from router to database queries in documentation?

Yes, you can trace FastAPI routes from router to service to database queries in your documentation. The generated APIs.md includes per-route sections that map the full request and response flow.

How do I generate API docs for a FastAPI project with dual core and ee editions?

Generate API docs for dual edition FastAPI projects by targeting the core/ and ee/ directory structures. The documentation process scans both editions and outputs a unified APIs.md file.

Will regenerating API documentation overwrite my manual notes in APIs.md?

Regenerating API documentation maintains compatibility with existing manual notes in APIs.md. The tool updates or creates the file as needed while preserving your added content.

What is the best way to document SQLAlchemy models and FastAPI services?

The best way to document SQLAlchemy models and FastAPI services is to auto-generate a living APIs.md reference. This approach provides file-level summaries for each Python module alongside per-route API documentation.

Does generated API documentation include request and response schemas for FastAPI?

Generated API documentation includes request and response schemas for FastAPI. The structured APIs.md output details schemas and code traces for every documented route.