Provides comprehensive guidance for generating API documentation by scanning code interfaces, extracting request/response information, and creating standardized API documentation. Use ONLY when the user explicitly mentions generating API documentation, creating API docs, scanning interfaces, or documenting APIs. The skill scans Controller classes, extracts interface information (URL, method, parameters, response), and generates documentation following standard templates. Do NOT trigger for generic documentation requests without explicit API documentation mention.
View on GitHubpartme-ai/full-stack-skills
development-skills-utils
February 1, 2026
Select agents to install to:
npx add-skill https://github.com/partme-ai/full-stack-skills/blob/main/skills/api-doc-generator/SKILL.md -a claude-code --skill api-doc-generatorInstallation paths:
.claude/skills/api-doc-generator/## When to use this skill **CRITICAL: This skill should ONLY be triggered when the user explicitly mentions generating API documentation, creating API docs, scanning interfaces, or documenting APIs.** **ALWAYS use this skill when the user mentions:** - Generating API documentation (explicitly mentions "API documentation" or "API docs") - Creating API documentation from code - Scanning interfaces to generate documentation - Documenting REST APIs - 生成接口文档 (explicitly mentions "接口文档") - 扫描接口生成文档 (scan interfaces to generate documentation) - 创建API文档 (create API documentation) **Trigger phrases include:** - "生成接口文档" (generate API documentation) - **must include "接口文档"** - "扫描接口生成文档" (scan interfaces to generate documentation) - "创建API文档" (create API documentation) - "为接口生成文档" (generate documentation for interfaces) - "接口文档生成" (API documentation generation) **DO NOT trigger this skill for:** - Generic documentation requests without mentioning API/interfaces - Code comments generation - README file generation - Other types of documentation (user guides, technical specs, etc.) - "生成文档" without "接口" or "API" (too generic) ## How to use this skill **CRITICAL: This skill should ONLY be triggered when the user explicitly mentions generating API documentation. Do NOT trigger for generic documentation requests without API context.** ### Workflow Overview This skill follows a systematic 4-step workflow: 1. **Scan Code** - Check current project or specified objects for Controller classes and API interfaces 2. **Extract Information** - Scan interfaces to collect request URL, method, parameters, and response information 3. **Generate Documentation** - Create API documentation following the standard template 4. **Save Output** - Save documentation to `./docs` directory in the current project ### Step-by-Step Process #### Step 1: Scan Code for Interfaces **CRITICAL: Before generating any documentation, you MUST scan the code to find API interfaces.** 1. **Identify Target**