Can it extract types from TypeScript and Python libraries?

Yes, it can extract type definitions from TypeScript interfaces, Zod, and Yup, as well as Python Pydantic models, dataclasses, and TypedDicts.

Which web frameworks are supported by this skill?

The skill supports a wide range of frameworks including Express.js, Fastify, Hono, Next.js (App and Pages router), Flask, FastAPI, and Django REST framework.

Does it work with existing Swagger or OpenAPI files?

Absolutely. The skill can detect and incorporate data from existing openapi.yaml/json and swagger.yaml/json files into the generated documentation.

How do I trigger the API documentation process?

You can use the slash command /docs:api or simply ask Claude to 'generate API specifications' or 'map the endpoints' within your workspace.

API Documentation Generator

Name: API Documentation Generator
Author: thkt

bythkt

•

API Development

Generates comprehensive API specifications and documentation by analyzing your codebase's endpoints, types, and schemas.

This skill automates the creation of technical API documentation by scanning your repository for REST endpoints, function signatures, and type definitions across multiple frameworks like Express, FastAPI, and Next.js. It extracts critical metadata including HTTP methods, request/response models, and schema definitions from TypeScript, Python, or OpenAPI files. By providing a standardized markdown output based on real-time code analysis, it ensures your documentation stays synchronized with your actual implementation, saving developers hours of manual writing and updating.

Key Features

01Automated REST endpoint detection for popular Node.js and Python frameworks

023 GitHub stars

03Standardized Markdown output based on customizable API templates

04Deep integration with existing OpenAPI/Swagger definitions

05Type extraction from TypeScript interfaces, Zod schemas, and Pydantic models

06Function signature analysis using tree-sitter for accurate documentation

Use Cases

01Standardizing API documentation structure across a complex microservices architecture

02Keeping documentation perfectly synchronized with code changes during rapid development cycles

03Generating initial API documentation for legacy projects lacking existing specifications

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