بنقرة واحدة
api-doc-gen
接口文档生成技能。根据代码或口述描述,生成标准格式的 RESTful API 接口文档,包含请求方法、路径、参数、响应示例、错误码等完整信息。适用于后端工程师在接口开发完成后生成接口文档。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
接口文档生成技能。根据代码或口述描述,生成标准格式的 RESTful API 接口文档,包含请求方法、路径、参数、响应示例、错误码等完整信息。适用于后端工程师在接口开发完成后生成接口文档。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
架构评审技能。对技术方案、系统设计、重构计划进行结构化评审,输出评审意见和修改建议。适用于架构师评审后端/前端/DevOps 提交的技术方案,CTO 对重大架构决策的把关,以及团队内部技术方案 Review。
缺陷与故障分析技能。对线上 Bug、测试缺陷、系统故障进行根因分析,输出分析报告和改进建议。适用于后端工程师分析线上 Bug、DevOps 进行故障复盘、QA 输出阶段质量分析报告。
商务技术方案生成技能。将客户需求转化为对外的技术商务方案文档,包含解决方案描述、技术优势、实施计划和报价说明。适用于 CTO 对客户进行技术方案展示和商务拓展场景。
代码审查技能。对提交的代码进行结构化检查,输出评审意见。适用于后端工程师、前端工程师提交 MR 前的自检,以及互相 Review 他人代码。包含逻辑正确性、异常处理、安全性、性能、可读性等维度。
部署检查清单技能。在每次生产环境上线前,生成并执行标准化的上线检查清单,确保代码、测试、数据库、回滚方案均已就绪。适用于 DevOps 工程师执行上线操作前的标准检查流程。
前端性能分析技能。分析前端页面的加载性能、渲染性能和资源体积问题,输出性能分析报告和优化建议。适用于前端工程师处理页面加载慢、交互卡顿等性能问题。
| 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 | 服务器内部错误 |