Which frameworks does this skill support?

It supports a wide range of popular frameworks including Express, Fastify, Hono, Next.js, Flask, FastAPI, and Django REST.

How do I trigger the documentation generation?

You can use the /docs:api command or simply ask Claude to 'Generate API specification' in natural language within your terminal.

Can it extract complex data types?

Yes, it can extract definitions from TypeScript interfaces, Zod, Yup, Pydantic, and standard Python dataclasses to document your data models.

Does it require manual configuration for each project?

No, the skill uses framework detection patterns to automatically identify endpoints and types based on your project's structure.

Does it generate OpenAPI/Swagger files?

While it primarily generates structured Markdown specifications, it analyzes existing OpenAPI/Swagger files and can assist in drafting the content required for those formats.

API Specification Generator

Name: API Specification Generator
Author: thkt

bythkt

•

API 开发

Generates comprehensive API specification documentation by automatically analyzing codebase endpoints, type definitions, and request/response schemas.

The documenting-apis skill empowers Claude to perform deep static analysis of your backend codebase to automatically extract and document REST endpoints, function signatures, and data models. Supporting popular frameworks like Express, FastAPI, and Next.js, it translates raw code into structured API specifications including request parameters, response examples, and type definitions, making it an essential tool for maintaining up-to-date documentation and streamlining the developer hand-off process without manual data entry.

主要功能

01Structural analysis of JSDoc, docstrings, and function signatures

02Automated REST endpoint detection for major web frameworks like Express, FastAPI, and Next.js

033 GitHub stars

04Deep type extraction for TypeScript interfaces, Zod schemas, and Pydantic models

05Support for OpenAPI/Swagger schema detection and synchronization

06Generation of formatted Markdown API specifications with request/response tables

使用场景

01Keeping documentation in sync with code changes during active development sprints

02Creating initial API documentation for an existing legacy codebase

03Mapping out endpoint structures and data models for team review or client hand-off

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add thkt/claude-config documenting-apis

For use in Claude.ai and ChatGPT

Download Skill