用 ChatGPT 编写 OpenAPI 接口文档
EnglishChatGPT 安装步骤
- 在支持创建技能的 ChatGPT 工作区打开「插件 → 技能 → 创建 → 使用编辑器创建」。
- 对照固定版本 GitHub 原文，在编辑器新建技能，将 `api-documentation` 的纯文本工作流程改写为技能说明。
- 保存后，在新对话输入 @ 并选中刚创建的技能，再用示例试用。
中文摘要
把已知的请求参数、状态码和响应样例整理为 OpenAPI 草案，并标记未提供的接口约束。
SKILL.md 中文导读
可复现示例
为 Garden beds 接口编写可核对的文档样例。
api="Garden beds"; operation="GET /beds"; limitType="integer"; limitMaximum=20; successStatus=200; successBody=[{"id":"bed-a"}]; invalidStatus=400; invalidBody={"error":"invalid limit"}工作步骤
- 核对路径、HTTP 方法、limit 类型与数量上限。
- 分别写成功和错误响应，并保留待确认的接口约束。
验收方法
接口草案包含 `GET /beds; limit: integer; maximum: 20; codes: 200/400`，并分别附上给定的响应结构和样例。认证要求和限流待确认。
GitHub 原文 · 更新日期
适用环境
支持创建技能的 ChatGPT 工作区。使用以下虚构材料作为纯文本输入。
常见问题
如何用 ChatGPT 文档化 OpenAPI 参数和错误响应？
先按 HTTP 方法和路径组织接口，再写参数类型、成功码、错误码与响应结构。凭给定样例核对，缺失的接口约束用待确认标记。