메뉴
接口文档生成技能。根据代码或口述描述，生成标准格式的 RESTful API 接口文档，包含请求方法、路径、参数、响应示例、错误码等完整信息。适用于后端工程师在接口开发完成后生成接口文档。
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
직접 명령은 검토 Prompt를 거치지 않습니다. 실행하기 전에 소스를 확인하세요.
npx skills add https://github.com/rowankid/ai-team --skill api-doc-gen명령은 한 줄로 유지됩니다. 복사하기 전에 가로로 스크롤해 전체 내용을 확인하세요.
로컬 사본을 원하시나요? SkillsMP에서 현재 제공할 수 있는 파일을 다운로드하세요.
架构评审技能。对技术方案、系统设计、重构计划进行结构化评审，输出评审意见和修改建议。适用于架构师评审后端/前端/DevOps 提交的技术方案，CTO 对重大架构决策的把关，以及团队内部技术方案 Review。
缺陷与故障分析技能。对线上 Bug、测试缺陷、系统故障进行根因分析，输出分析报告和改进建议。适用于后端工程师分析线上 Bug、DevOps 进行故障复盘、QA 输出阶段质量分析报告。
商务技术方案生成技能。将客户需求转化为对外的技术商务方案文档，包含解决方案描述、技术优势、实施计划和报价说明。适用于 CTO 对客户进行技术方案展示和商务拓展场景。
SOC 직업 분류 기준
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 | 服务器内部错误 |