编程开发 通用 中文 English REST API 集成 将 [API name / endpoint docs] 集成到此仓库的代码库中。在编写任何内容之前,先阅读实际的 API 文档和现有代码… 生成后的提示词 将 `[API name / endpoint docs]` 集成到此仓库的代码库中。 在编写任何内容之前,先阅读实际的 API 文档和现有代码。 ## 步骤 1. **阅读 API** - 理解你需要的端点:请求/响应 结构、认证、速率限制、分页和错误语义。阅读实际的 文档,而不是仅根据 URL 猜测。 2. **匹配代码库** - 使用现有的 HTTP 客户端、错误处理、 日志记录和配置模式。除非现有库无法完成工作, 否则不要引入新的 HTTP 库。 3. **类型与边界** - 定义与 API 契约匹配的类型化请求/响应模型(或等价物)。 将集成保持在小的边界之后,这样 调用方就不依赖传输格式。 4. **处理真实世界** - 超时、对瞬时故障进行带退避的重试、 针对 4xx/5xx 的清晰错误、分页和速率限制处理。 不要无限重试,不要吞掉错误。 5. **认证与配置** - 将凭据保存在配置/环境变量/密钥中,绝不硬编码。 遵循仓库现有的密钥处理约定。 6. **测试** - 为集成的行为编写测试:成功路径、错误 映射、重试和边缘情况(空响应、格式错误的负载)。 使用仓库现有的测试替身(mocks/fixtures/cassettes),并 确认测试套件运行通过。 ## 验证 - [ ] 请求和响应结构、认证、速率限制和错误语义均从真实文档中读取,而非从 URL 推断。 - [ ] 复用了仓库现有的 HTTP 客户端、错误处理、日志记录和配置模式,而非替换它们。 - [ ] 调用方依赖类型化边界,而非传输格式。 - [ ] 超时、带退避的有界重试、4xx 和 5xx 映射、分页和速率限制均已处理,没有无限重试,也没有吞掉错误。 - [ ] 凭据来自配置或密钥,且测试套件覆盖成功、错误映射、重试、空响应和格式错误的负载,并显示输出通过。 ## 规则 - 绝不将 API 文档中的示例代码原样粘贴到代码库中 - 要使其适配 仓库的约定。 - 尽可能根据真实响应验证你对 API 的假设。 - 如果文档和实际 API 不一致,标记出来并验证,而不是 猜测哪个正确。 复制提示词 分享提示词 查看示例 发送到 AI 优化器 收藏模板 保存当前版本 示例 关闭 分享 卡片风格 雾面玻璃 暖白纸笺 深夜蓝图 薄荷网格 珊瑚日落 水墨笺 关闭 图片仅展示节选。