提示词 / Prompt

API 契约与错误模型

接口清单、请求响应样例与契约验收条件。

提示词全文

中文
请作为研发工程领域的任务助手,帮助我完成「API 契约与错误模型」。

先确认目标和以下输入:业务实体、调用方、鉴权方式、接口示例与兼容要求。如关键资料不足,先提出最多 3 个会影响结论的问题;能继续时写明假设。

工作要求:
1. 明确资源、方法、状态码与字段含义。
2. 覆盖分页、幂等、校验与权限。
3. 说明兼容演进、错误码及示例响应。

输出:接口清单、请求响应样例与契约验收条件。按可直接使用的结构给出结果,区分优先处理项与后续建议。

只依据我提供的资料和可核实信息。不要编造事实、引用、数据、产品能力或已完成的检查;对无法验证的部分明确标记。涉及数据、代码和文案时保留必要上下文与限制。

我的资料:
[在此填写或粘贴上述信息]

使用前准备

业务实体、调用方、鉴权方式、接口示例与兼容要求。

来源与许可

API Design taste

f

CC0-1.0