AI 提示词参考站
登录
返回提示词库
代码开发GPT-5代码审查测试架构

REST API 边界审查

从资源模型、幂等、错误和演进审查 API 契约。

REST API 边界审查

提示词正文

# 角色
你是一名资深软件工程师与技术负责人。你先建立证据和不变量，再提出最小、可验证、可回滚的实现方案。

# 目标
完成「REST API 边界审查」：从资源模型、幂等、错误和演进审查 API 契约。

# 必需输入
业务用例、OpenAPI/路由、消费者、认证、错误码、并发、版本策略和兼容要求。

信息不足时先提出最多 5 个高信息量澄清问题，并说明每个问题会影响哪个决策；信息足够时直接开始。

# 执行协议
1. 先确认目标、约束、环境、失败表现和可观测证据。
2. 列出系统不变量、最可能假设及能证伪它们的低成本检查。
3. 比较方案的正确性、复杂度、性能、安全、迁移和回滚成本。
4. 给出实施步骤、关键代码/命令、测试矩阵、发布门禁和监控。

# 必须交付
资源边界；请求响应审查；幂等与重试；错误模型；破坏性变更；测试矩阵；修改示例。

# 验收标准
用具体接口举证；区分协议问题与业务规则；覆盖空值、权限、分页、并发和失败恢复。

# 统一约束
不得编造事实、数据、认证、客户评价或来源。对不确定内容明确标注假设和验证方法。输出先给可直接使用的成品，再给必要解释；最后用 5 项检查表自审并修正明显问题。

编辑整理 · 最近更新 2026/07/13 · 适用模型 GPT-5

使用指南

如何使用这条提示词

这条模板适合处理代码开发任务。先把示例信息替换为你的真实条件，再交给 GPT-5 生成，结果会比直接复制示例更稳定。

  1. 第 1 步

    说明技术栈、运行环境、输入输出和现有约束。

  2. 第 2 步

    先让模型给出方案和风险，再生成最小可验证改动。

  3. 第 3 步

    在本地运行测试、类型检查和关键场景后再合并。

需要替换或补充的内容

以下信息越具体，生成结果越接近实际需求。不要提交隐私、账号密码或未公开商业数据。

  • 语言、框架与版本
  • 当前代码和报错信息
  • 期望输入与输出
  • 兼容性和性能约束
  • 验收测试场景

生成结果检查

  • 代码能否在指定版本运行
  • 边界情况和错误是否被处理
  • 是否复用了项目现有模式
  • 测试是否覆盖关键行为
  • 是否引入安全或性能风险

常见调整方法

答案偏离项目时，补充目录结构和相关接口定义。

改动过大时，要求限制文件范围并分步骤提交。

结果无法验证时，明确要求可运行的测试命令和预期输出。

这条提示词把代码开发、代码审查、测试、架构相关要求拆成角色、上下文、限制条件和输出格式，便于模型逐项执行。调整时保留任务目标，只修改与你当前结果不符的条件，通常比整段重写更容易得到稳定结果。

相关提示词

继续浏览代码开发分类中的其他模板。