huangjia2019/claude-code-engineering / 04-Skills/projects/02-progressive-skill
api-documenting
VerifiedGenerate 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.
| File | Kind | Size |
|---|---|---|
| EXAMPLES.md | markdown | 2.7 KB |
| PATTERNS.md | markdown | 1.6 KB |
| README.md | markdown | 2.9 KB |
| SKILL.md | skill md | 1.5 KB |
| STANDARDS.md | markdown | 1.7 KB |
| scripts/detect_routes.py | script | 4.3 KB |
| scripts/validate_openapi.sh | script | 1.7 KB |
| templates/endpoint.md | markdown | 873 B |
| templates/index.md | markdown | 1004 B |
| templates/openapi.yaml | config | 1.9 KB |
PATTERNS.md
View on GitHub# API Documentation Patterns
## Common Frameworks
### Express.js
```javascript
// Route pattern
app.get('/users/:id', handler)
router.post('/auth/login', authController.login)
// Look for:
// - app.get(), app.post(), etc.
// - router.METHOD()
// - @route decorators (if using decorators)
```
### FastAPI (Python)
```python
# Route pattern
@app.get("/users/{user_id}")
@router.post("/auth/login")
# Look for:
# - @app.METHOD decorators
# - @router.METHOD decorators
# - Pydantic models for schemas
```
### Spring Boot (Java)
```java
// Route pattern
@GetMapping("/users/{id}")
@PostMapping("/auth/login")
@RequestMapping(value = "/api", method = RequestMethod.GET)
// Look for:
// - @XXXMapping annotations
// - @RequestMapping
// - @RestController classes
```
### Go (Gin/Echo)
```go
// Route pattern
r.GET("/users/:id", handler)
e.POST("/auth/login", controller.Login)
// Look for:
// - router.METHOD() calls
// - Group definitions
// - Middleware attachments
```
## Parameter Detection
### Path Parameters
- Express: `:paramName`
- FastAPI: `{param_name}`
- Spring: `{paramName}`
- Go: `:paramName` or `*paramName`
### Query Parameters
Look for:
- `req.query` (Express)
- `Query()` (FastAPI)
- `@RequestParam` (Spring)
- `c.Query()` (Gin)
### Body Parameters
Look for:
- `req.body` (Express)
- Pydantic models (FastAPI)
- `@RequestBody` (Spring)
- `c.Bind()` (Gin)
## Response Detection
### Status Codes
- Look for explicit status codes: `res.status(201)`, `status_code=201`
- Default is usually 200
- Error handlers indicate error codes
### Response Schema
- TypeScript interfaces/types
- Pydantic models
- Java DTOs
- Go structs with json tags
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 469k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 197k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |