Skills
.Work. You
Rest

generate-api-code-documentation

Official

Auto-generates API docs from FastAPI projects.

Software Engineering#documentation#api#fastapi#sqlalchemy#generate#code-review
Authortonehq
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: generate-api-code-documentation
Download link: https://github.com/tonehq/tone/archive/main.zip#generate-api-code-documentation

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.