文案写作 通用 中文 English API 文档 为该仓库中的 [endpoint \/ route group \/ service] 生成 API 文档。目标:文档要准确描述…… 生成后的提示词 为该仓库中的 `[endpoint \/ route group \/ service]` 生成 API 文档。目标:文档要准确描述真实的 API,而不是与代码不匹配的理想化版本。 ## 步骤 1. **阅读实际代码** - 从路由定义追踪每个端点,经过处理程序逻辑直到响应。识别请求形状(参数、请求体、请求头、查询),响应形状(状态码、响应体架构、响应头),以及错误情况。不要仅根据路由名称推断。 2. **识别输出格式** - 检查该仓库已经使用的格式:OpenAPI YAML\/JSON、Markdown 端点文档、JSDoc\/OpenAPI 注解,或没有。遵循现有格式;如果不存在,建议 OpenAPI 3.x。 3. **记录每个端点** - 方法和路径、描述、每个参数(路径、查询、请求头、请求体)及其类型和约束、成功响应、每个错误响应及其发生时机、认证要求,以及适用时的速率限制。 4. **添加示例** - 为每个端点添加真实的请求和响应示例,使用代码中的数据形状而不是占位值,覆盖成功和错误情况。 5. **验证准确性并集成** - 对照代码交叉检查每个记录的参数、响应字段和状态码,运行端点或阅读其测试。确认文档在仓库使用的任何站点或生成器中可渲染,并验证生成的规范。 ## 验证 - [ ] 每个记录的端点都从路由定义追踪到处理程序,因此没有一个是编造的。 - [ ] 每个参数、响应字段和状态码都与其生成代码进行了交叉检查。 - [ ] 每个端点都有真实的请求和响应示例,尽可能取自实际输出。 - [ ] 代码处理的错误情况,包括具体错误码,均已记录。 - [ ] 文档已使用仓库已经使用的任何工具生成或验证,并且输出干净。 - [ ] 当文档和代码不一致时,以代码为准,并已修正文档。 ## 规则 - 切勿记录代码中不存在的端点。 - 切勿记录代码实际未使用或未返回的参数或响应字段。 - 如果代码处理了边缘情况(例如特定错误码),请记录它——不要因为它不常见就省略。 - 如果现有文档和代码不一致,以代码为准,文档需要修正。 复制提示词 分享提示词 查看示例 发送到 AI 优化器 收藏模板 保存当前版本 示例 关闭 分享 卡片风格 雾面玻璃 暖白纸笺 深夜蓝图 薄荷网格 珊瑚日落 水墨笺 关闭 图片仅展示节选。