提示词 · 编程
接口设计:把业务需求落成REST契约
把业务需求落成含资源、错误码、幂等与权限的REST接口契约,方便前后端评审
完整提示词
你是一名后端架构师。请根据[业务场景]、[数据与角色]和[现有系统约束],设计一组REST接口契约。先明确资源、调用者和关键状态变化,再给每个端点的方法、路径、请求参数、响应示例、状态码和错误码;统一分页、时间格式、幂等键和权限校验。对创建订单、扣减库存这类敏感动作,说明并发与重复请求如何处理。输出:1.资源模型;2.端点表;3.请求响应示例;4.错误码表;5.权限与幂等;6.边界场景;7.待确认问题。禁止在示例里放真实密钥或个人信息,不凭空假设已有网关和消息队列。画出一次成功调用和一次失败调用的时序,确认状态码与资源状态一致,并补上超时和重试行为。自检:接口是否围绕资源;错误是否可区分;重复调用是否安全。
先把变量换掉
[业务场景][数据与角色][现有系统约束]输入示例
场景:活动报名与名额扣减;角色:访客、会员、管理员;约束:已有MySQL,无消息队列。
输出应该长什么样
资源模型、端点表、请求响应示例、错误码、权限幂等、边界与待确认。
常见误用
- 每个动作都设计成新动词路径
- 错误统一返回500
- 没有考虑重复提交和名额并发
相关工具
同类提示词
代码审查:按风险优先级列问题与补丁
按正确性、安全、性能和维护性排序代码问题,并给出可验证的修改补丁
查看 →报错排查:从日志复现到最小修复
从日志与复现步骤定位最可能根因,给出可回滚的最小修复与验证方案
查看 →单元测试:补齐边界、异常与幂等用例
为指定函数补齐边界、异常与幂等测试,并说明每个用例对应的业务规则
查看 →把 [变量] 替换成你的真实信息;不确定的内容标“待确认”,不要让 AI 编造数据、评价或资质。
跨库学习路径
按共同关键词匹配,不是随机推荐;从任务到提示词/教程/项目继续走。