API Doc Gen

接口文档生成技能。根据代码或口述描述,生成标准格式的 RESTful API 接口文档,包含请求方法、路径、参数、响应示例、错误码等完整信息。适用于后端工程师在接口开发完成后生成接口文档。

rowankid ad4c904 1.1 KB Updated

File contents

API Doc Gen Skill — 接口文档生成技能

输出模板

# 接口文档 — [模块名]

版本: v1.0 | 日期: YYYY-MM-DD | 负责人:

## 接口列表

### [接口名称]

**方法**: GET / POST / PUT / DELETE  
**路径**: /api/v1/xxx  
**描述**: [一句话说明接口用途]  
**认证**: 是 / 否

#### 请求参数

| 参数名 | 类型 | 必填 | 说明 | 示例 |
|--------|------|------|------|------|

#### 请求示例

\`\`\`json
{
}
\`\`\`

#### 响应参数

| 字段名 | 类型 | 说明 |
|--------|------|------|

#### 响应示例(成功)

\`\`\`json
{
  "code": 0,
  "message": "success",
  "data": {}
}
\`\`\`

#### 错误码

| 错误码 | 说明 |
|--------|------|
| 400 | 参数错误 |
| 401 | 未认证 |
| 403 | 无权限 |
| 500 | 服务器内部错误 |

rowankid/ai-team/tree/main/skills/api-doc-gen commit ad4c90493c

Frequently asked questions

npx skillmds@latest add rowankid/api-doc-gen