Generating API Docs 技能：补齐 OpenAPI 示例和错误说明

Claude Code 安装步骤

从 GitHub 固定提交获取完整的 `plugins/api-development/api-documentation-generator/skills/generating-api-docs` 目录。
复制到目标项目的 `.claude/skills/`，确认 `.claude/skills/generating-api-docs/SKILL.md`，再从项目根目录启动 Claude Code，输入 `/generating-api-docs`。

用 Claude Code 从 OpenAPI 定义生成 API 快速入门，整理请求示例、响应样本和错误处理，并在本地文档页复核。

在 OpenAPI 中为 GET /products/{id} 写明整型 id、200 成功和 404 未找到。让本地测试接口在 id=7 时返回 Demo Mug，查询 id=999 时返回 PRODUCT_NOT_FOUND，再核对文档预览的两种响应。

文档列出可执行的本地请求和两种响应，返回内容可对照实际测试结果，错误码有明确含义。

GitHub 原文 · 更新日期 2026-11-13

准备本地 API、OpenAPI 3 定义与 Swagger UI 或同类预览工具。示例使用合成商品 ID。

为客户端可能遇到的状态记录响应结构、示例和处理建议，尤其要说明稳定错误码。