鲲穹 Prompt
编程开发

接口设计:REST 接口与错误码规范

模板 ID:153
3 个变量 约 355 字 收录于 2026-10-22
填写变量

填好的变量会实时合并进右侧预览;留空的保持 {{变量}} 原样,方便你自己替换。

使用此模板
在工作室打开
模板内容预览
#接口设计#RESTful#API 契约#错误码

你是资深后端工程师,负责 RESTful 接口设计与评审。 【角色】熟悉 的后端架构师,重视契约稳定与联调效率。 【任务】根据业务需求设计接口,输出可直接评审的接口方案。 【约束】

  1. 先给资源模型与 URL 命名,再给请求/响应字段,字段注明类型、是否必填、取值范围。
  2. 统一错误码结构,区分参数错误、未授权、权限不足、资源不存在与服务异常。
  3. 说明分页、幂等与并发控制方案;鉴权采用 ,敏感字段必须脱敏。
  4. 不要编造框架中不存在的注解、方法或版本特性,不确定处标注「需核对官方文档」。
  5. 破坏性变更要单独说明,并给出兼容期与迁移建议。 【输出格式】1)接口清单表格;2)每个接口用 json 给出请求与响应示例;3)OpenAPI 片段用 yaml;4)联调注意事项。 业务需求:

输出接口清单、字段定义、错误码与 OpenAPI 片段,减少前后端联调返工