提示词 · 编程

接口设计:把业务需求落成REST契约

把业务需求落成含资源、错误码、幂等与权限的REST接口契约,方便前后端评审

编程后端架构师

完整提示词

你是一名后端架构师。请根据[业务场景]、[数据与角色]和[现有系统约束],设计一组REST接口契约。先明确资源、调用者和关键状态变化,再给每个端点的方法、路径、请求参数、响应示例、状态码和错误码;统一分页、时间格式、幂等键和权限校验。对创建订单、扣减库存这类敏感动作,说明并发与重复请求如何处理。输出:1.资源模型;2.端点表;3.请求响应示例;4.错误码表;5.权限与幂等;6.边界场景;7.待确认问题。禁止在示例里放真实密钥或个人信息,不凭空假设已有网关和消息队列。画出一次成功调用和一次失败调用的时序,确认状态码与资源状态一致,并补上超时和重试行为。自检:接口是否围绕资源;错误是否可区分;重复调用是否安全。

先把变量换掉

[业务场景][数据与角色][现有系统约束]

输入示例

场景:活动报名与名额扣减;角色:访客、会员、管理员;约束:已有MySQL,无消息队列。

输出应该长什么样

资源模型、端点表、请求响应示例、错误码、权限幂等、边界与待确认。

常见误用

相关工具

MarkKit 工具箱

打开即用

打开 →

AI 编程一条龙

放进完整流程

继续 →

同类提示词

代码审查:按风险优先级列问题与补丁

按正确性、安全、性能和维护性排序代码问题,并给出可验证的修改补丁

查看 →

报错排查:从日志复现到最小修复

从日志与复现步骤定位最可能根因,给出可回滚的最小修复与验证方案

查看 →

单元测试:补齐边界、异常与幂等用例

为指定函数补齐边界、异常与幂等测试,并说明每个用例对应的业务规则

查看 →
把 [变量] 替换成你的真实信息;不确定的内容标“待确认”,不要让 AI 编造数据、评价或资质。

跨库学习路径

按共同关键词匹配,不是随机推荐;从任务到提示词/教程/项目继续走。

教程

商品图压到 200KB 还不糊:先改尺寸还是先降质量

学会先缩尺寸再降质量的两段式压缩,把商品图稳定压到 200KB 以内且文字边缘仍然可读。

从提示词到教程的下一步

继续 →
技能

小红书封面标题:3 秒说清人群和结果

把封面标题压到 12 字内,先说人群再说结果,让目标用户在信息流里一眼判断是否与自己有关。

从提示词到技能的下一步

继续 →
项目

给连锁口腔诊所写 12 篇种植牙科普推文,用于公众号留资

12 篇 800 字科普文 + 6 组医患问答 + 1 份四周发布排期

从提示词到项目的下一步

继续 →