Api documenting
This repository demonstrates how to use Claude Code to do real engineering work, not just writing code. 本项目是极客时间专栏 《Claude Code 工程化实战》 的官方配套示例仓库，目标就是： 👉 把 Claude Code 从“对话式编码工具”，变成 可设计、可复用、可治理的工程系统。
npx -y skills add huangjia2019/claude-code-engineering --skill api-documentingAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
What its author says it does
Copied from the file, not written here
Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.
SKILL.md
1.5 KB, as published. Nobody here has run it
API Documentation Generator
Generate comprehensive API documentation from source code.
Quick Reference
For common documentation patterns, see PATTERNS.md.
Documentation Standards
See STANDARDS.md for our documentation conventions.
Process
Step 1: Identify API Endpoints
Look for:
- Route definitions (Express, FastAPI, etc.)
- Controller methods
- Handler functions
Step 2: Extract Information
For each endpoint, extract:
- HTTP method (GET, POST, PUT, DELETE, etc.)
- Path/route
- Parameters (path, query, body)
- Request/response schemas
- Authentication requirements
Step 3: Generate Documentation
Use the template in templates/endpoint.md for consistent formatting.
Step 4: Create Overview
Generate an index of all endpoints with the template in templates/index.md.
Output Formats
Markdown (Default)
Generate markdown documentation suitable for README or docs site.
OpenAPI/Swagger
If requested, generate OpenAPI 3.0 spec. See templates/openapi.yaml for structure.
Examples
See EXAMPLES.md for sample inputs and outputs.
Scripts
To auto-detect routes in common frameworks:
python scripts/detect_routes.py <source_directory>
To validate generated OpenAPI spec:
./scripts/validate_openapi.sh <spec_file>