Api generating
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-generatingAssembled 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 endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.
SKILL.md
1.5 KB, as published. Nobody here has run it
API Documentation Generator
Generate comprehensive API documentation from source code.
Quick Reference
| Task | Resource |
|---|---|
| Identify framework | See PATTERNS.md |
| Documentation standards | See STANDARDS.md |
| Example outputs | See EXAMPLES.md |
Process
Step 1: Identify API Endpoints
Look for route definitions. For framework-specific patterns, see PATTERNS.md.
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 each endpoint.
Step 4: Create Overview
Generate an index using templates/index.md.
Output Formats
Markdown (Default)
Generate markdown suitable for README or docs site.
OpenAPI/Swagger
If requested, generate OpenAPI 3.0 spec. See templates/openapi.yaml.
Automation
To auto-detect routes:
python scripts/detect_routes.py <source_directory>
To validate OpenAPI spec:
./scripts/validate_openapi.sh <spec_file>