Menu
接口文档生成技能。根据代码或口述描述，生成标准格式的 RESTful API 接口文档，包含请求方法、路径、参数、响应示例、错误码等完整信息。适用于后端工程师在接口开发完成后生成接口文档。
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
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.
A direct command skips the review prompt. Inspect the source before running it.
npx skills add https://github.com/rowankid/ai-team --skill api-doc-genThe command stays on one line. Scroll horizontally to inspect it before copying.
Prefer a local copy? Download the files currently available to SkillsMP.
Showing SKILL.md
| name | api-doc-gen |
| description | 接口文档生成技能。根据代码或口述描述，生成标准格式的 RESTful API 接口文档，包含请求方法、路径、参数、响应示例、错误码等完整信息。适用于后端工程师在接口开发完成后生成接口文档。 |
# 接口文档 — [模块名]
版本: v1.0 | 日期: YYYY-MM-DD | 负责人:
## 接口列表
### [接口名称]
**方法**: GET / POST / PUT / DELETE
**路径**: /api/v1/xxx
**描述**: [一句话说明接口用途]
**认证**: 是 / 否
#### 请求参数
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|--------|------|------|------|------|
#### 请求示例
\`\`\`json
{
}
\`\`\`
#### 响应参数
| 字段名 | 类型 | 说明 |
|--------|------|------|
#### 响应示例（成功）
\`\`\`json
{
"code": 0,
"message": "success",
"data": {}
}
\`\`\`
#### 错误码
| 错误码 | 说明 |
|--------|------|
| 400 | 参数错误 |
| 401 | 未认证 |
| 403 | 无权限 |
| 500 | 服务器内部错误 |
Based on SOC occupation classification