api-doc-generator
Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.
npx skills add JackyST0/awesome-agent-skills --skill api-doc-generator --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# API Doc Generator > 根据代码生成 API 文档，支持 REST API、GraphQL 及多种文档格式。 > > Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats. ## When to Use 当用户请求以下操作时使用此 skill： - 生成 API 文档 / Generate API documentation - 创建接口文档 / Create interface documentation - 编写 API 说明 / Write API descriptions - 生成 OpenAPI/Swagger 规范 / Generate OpenAPI/Swagger specs ## Instructions ### 分析步骤 / Analysis Steps 1. **识别 API 类型** - REST、GraphQL、RPC 等 2. **提取端点信息** - URL、方法、参数 3. **分析数据结构** - 请求/响应格式 4. **识别认证方式** - API Key、OAuth、JWT 等 5. **生成文档** - 按照标准格式输出 ### 文档内容 / Documentation Content 每个 API 端点应包含： - **端点路径** - URL 和 HTTP 方法 - **描述** - 功能说明 - **参数** - 路径参数、查询参数、请求体 - **响应** - 成功和错误响应示例 - **认证** - 认证要求 ### 输出格式 / Output Formats 支持以下文档格式： - Markdown（默认）- 使用 `templates/api-doc.md` 模板 - OpenAPI 3.0 YAML - API Blueprint Use `templates/api-doc.md` for Markdown output format. ### 标准模板 / Standard Template ```markdown ## API 文档 / API Documentation ### 端点概览 / Endpoint Overview | 方法 | 路径 | 描述 | |------|------|------| | GET | /api/resource | 获取资源列表 | ### 详细说明 / Details #### [方法] /path **描述**: ... **请求参数**: | 参数 | 类型 | 必需 | 描述 | |------|------|------|------| **请求示例**: ```
- When to Use
- Instructions
- 分析步骤 / Analysis Steps
- 文档内容 / Documentation Content
- 输出格式 / Output Formats
- 标准模板 / Standard Template
- Examples
- 输入 / Input
- 输出 / Output
- API 文档
- 端点概览
- GET /users/{userid}
- POST /users
What does the api-doc-generator skill do?
Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.
How do I install it?
Run `npx skills add JackyST0/awesome-agent-skills --skill api-doc-generator --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From JackyST0/awesome-agent-skills, a repository with 613 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.