api-documentation
Claude Code api-documentation 技能：用 OpenAPI 写接口说明与示例
EnglishClaude Code 安装步骤
- 从下方 GitHub 原文打开固定提交，在同一提交中取得 `engineer/api-development/skills/api-documentation/` 技能目录。
- 将目录复制到项目内的 `.claude/skills/api-documentation/`，确认 `SKILL.md` 与附带文件位于该目录。
- 在项目根目录启动 Claude Code，输入 `/api-documentation` 加上示例中的任务说明。
中文摘要
根据 API 路由和数据结构起草 OpenAPI 文档，补充请求示例、响应字段、已定义错误和身份验证要求。
SKILL.md 中文导读
可复现示例
在本地准备一个图书接口 GET /books/{id} 的路由：查到时返回 200 和 id、title；找不到时返回 404 和 error。请生成对应的 OpenAPI 片段及两个响应示例。工作步骤
- 定位接口实现及其 schema。
- 记录实际参数、状态和错误格式。
- 用本地响应样例核对生成的片段。
验收方法
片段声明必填路径参数 id。两个响应示例使用与实现一致的字段，实际路由和文档可逐项比对。
GitHub 原文 · 更新日期
适用环境
Claude Code 与本地 API 路由、响应结构或已有的 OpenAPI 文件。
常见问题
怎样避免接口文档和代码变更后不一致？
用路由和响应 schema 核对参数、状态码和示例，并在接口变更时同步更新 OpenAPI 文件。