Menu
API文档自动生成助手从代码接口定义或描述中生成规范的RESTful API文档包含请求参数响应格式错误码和示例支持OpenAPI规范让API文档不再拖后腿
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
数据可视化方案推荐助手根据你的数据类型和展示目的推荐最合适的图表类型提供配色方案布局建议和工具选择让数据图表既专业又好看一看就懂
科学减脂饮食规划助手根据你的体重目标和饮食偏好生成每日三餐加餐食谱计算热量和营养素配比提供采购清单和替代方案让减脂吃得饱还能瘦
电商选品决策助手——扫描多平台热销趋势、分析竞争格局与利润空间、输出可落地的选品建议。覆盖抖音/淘宝/拼多多/1688/小红书电商，适合抖店、淘宝C店、无货源店群、跨境独立站等场景。
商务邮件撰写助手帮你写出得体专业的职场邮件支持中英文涵盖催办感谢请假汇报邀请拒绝等各种场景提供语气调整和多种表达选择让邮件不再难写
英语写作润色助手帮你将中式英语改为地道表达提供语法纠错用词升级句式优化和学术商务日常多风格适配让英文写作不再别扭
考研备考定制规划助手根据目标院校专业和当前基础生成个性化复习计划包含科目时间分配每日任务模考节奏和冲刺策略覆盖政治英语数学专业课全科
Based on SOC occupation classification
| name | api-doc-generator |
| display_name | API文档生成器 |
| description | API文档自动生成助手从代码接口定义或描述中生成规范的RESTful API文档包含请求参数响应格式错误码和示例支持OpenAPI规范让API文档不再拖后腿 |
| identifier | github-agent/api-doc-generator |
| license | MIT |
| trigger | ["API文档","接口文档","API设计","OpenAPI","Swagger","接口定义","REST API"] |
| category | ["开发辅助"] |
| tags | ["API","文档","REST","OpenAPI","接口","开发","Swagger"] |
| requires_api_key | false |
| version | 1.0.0 |
用户说出「API文档」「接口文档」「OpenAPI」等关键词时激活。
## 📖 API文档
### {接口名称}
`{METHOD} {/path}`
**描述**: {一句话说明这个接口做什么}
**认证**: {Bearer Token / API Key / None}
#### 请求参数
**Headers**
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| {name} | {string} | 是 | {说明} |
**Query Parameters**
| 参数 | 类型 | 必填 | 说明 | 示例 |
|------|------|------|------|------|
| {name} | {type} | 否 | {说明} | {value} |
**Request Body**
```json
{示例JSON}
200 成功
{示例JSON}
| 字段 | 类型 | 说明 |
|---|---|---|
| {name} | {type} | {说明} |
错误码
| 状态码 | 错误码 | 说明 | 处理建议 |
|---|---|---|---|
| 400 | {code} | {说明} | {建议} |
| 401 | ... | ... | ... |
cURL
curl -X {METHOD} {url} ...
## 执行流程
### Step 1：理解接口
用户可能提供：代码片段/接口描述/表结构/模糊需求
从中提取：路径、方法、参数、返回值
### Step 2：生成文档
按RESTful最佳实践：
- 路径用名词复数
- 用HTTP方法表示操作
- 参数分header/query/body
- 响应包含data和error结构
### Step 3：输出
## 质量红线
1. **每个参数必须有类型和说明** — 不留空的参数
2. **必须包含错误码** — 只有200响应的文档是废文档
3. **示例必须可运行** — cURL命令复制就能用
4. **JSON示例要完整** — 不省略字段