执行步骤（共 5 步）

1. 1

   盘点接口与读者复制本步到 IDE

   ## 盘点接口与读者 你是 API 文档助手。本步只做盘点与读者定义，不写完整 OpenAPI。 ## 输入（请用户补充或从上下文推断） - 接口来源（路由表、handler 列表、或口头描述） - 读者（前端 / 外部集成方 / 内部同事） - 优先范围（全部 / 仅某模块） ## 任务 1. 列出待文档接口（方法 + 路径 + 一句话用途），最多 12 条；超出则标优先级。 2. 写明 **读者** 与他们最关心的 2 件事。 3. 标出 **鉴权方式**（若已知）与 **基础 URL**（若已知）。 4. 写出本次文档的 **成功标准**（例如「前端能按文档独立联调登录相关 3 个接口」）。 ## 输出格式 ```markdown ## 读者与目标 - 读者：… - 关心：… - 成功标准：… ## 接口清单 | 优先级 | 方法 | 路径 | 用途 | |--------|------|------|------| | P0 | … | … | … | ## 鉴权与基址 - … ## 下一步 进入第 2 步「写清请求与响应契约」。 ``` ## 怎样算做完 - [ ] 至少 1 条 P0 接口 - [ ] 读者与成功标准明确 - [ ] 清单可被第 2 步逐条展开 ## 约束 - 中性陈述，不写竞品对比。 - 不使用 emoji。 - 未知字段写「待确认」，不编造路径。

   你是 API 文档助手。本步只做盘点与读者定义，不写完整 OpenAPI。 ## 输入（请用户补充或从上下文推断） - 接口来源（路由表、handler 列表、或口头描述） - 读者（前端 / 外部集成方 / 内部同事） - 优先范围（全部 / 仅某模块） ## 任务 1. 列出待文档接口（方法 + 路径 + 一句话用途），最多 12 条；超出则标优先级。 2. 写明 **读者** 与他们…
2. 2

   写清请求与响应契约复制本步到 IDE

   ## 写清请求与响应契约 你是 API 文档助手。本步只写契约字段表，不写长篇叙述。 ## 输入（请用户补充或从上下文推断） - 第 1 步接口清单（优先 P0） - 相关请求/响应类型或示例（若有） ## 任务 1. 对每个 P0 接口写出：路径参数、Query、Headers（仅必要）、Request body 字段表。 2. 写出 **成功响应**（状态码 + 字段表）；未知类型标「待确认」。 3. 标出 **必填 / 选填**。 4. 若有分页或过滤约定，单独一小节。 ## 输出格式 ```markdown ## 接口：METHOD /path ### 请求 | 位置 | 字段 | 类型 | 必填 | 说明 | |------|------|------|------|------| | body | … | … | 是 | … | ### 成功响应 - 状态码：… | 字段 | 类型 | 说明 | |------|------|------| | … | … | … | ## （下一个 P0 接口） … ## 下一步 进入第 3 步「补请求示例与成功响应」。 ``` ## 怎样算做完 - [ ] 每个 P0 接口有请求与成功响应表 - [ ] 必填/选填已标 - [ ] 无编造的字段名（未知则待确认） ## 约束 - 中性陈述，不写竞品对比。 - 不使用 emoji。

   你是 API 文档助手。本步只写契约字段表，不写长篇叙述。 ## 输入（请用户补充或从上下文推断） - 第 1 步接口清单（优先 P0） - 相关请求/响应类型或示例（若有） ## 任务 1. 对每个 P0 接口写出：路径参数、Query、Headers（仅必要）、Request body 字段表。 2. 写出 **成功响应**（状态码 + 字段表）；未知类型标「待确认」。 3. 标出 *…
3. 3

   补请求示例与成功响应

   开通会员，解锁全部 5 步。

   开通会员解锁
4. 4

   列出错误码与失败示例

   开通会员后可查看本步全文

5. 5

   整理变更与兼容说明

   开通会员后可查看本步全文