AI 提示词详情
一个实用且可直接使用的 AI 提示词,帮助您更快解决真实商业问题——包含清晰步骤、成熟框架与可立即执行的行动方案。
上线前验证并优化 API 接口(避免上线后返工)
在接口交付给用户前,提前发现不清晰的响应、缺失字段与边界情况。

解决的问题
开发者经常上线“能跑但不好用”的 API:缺少错误场景、响应不一致、命名含糊,会让前端或外部用户困惑,导致 Bug、返工和支持成本上升。
契约级验证
从使用者视角审阅 API 的可理解性。
错误优先思维
提前暴露真实世界会发生的失败场景。
更易集成的输出
让 API 更容易调试与对接。
AI 提示使用说明
请以资深后端工程师与 API 审阅者身份行事。
API 接口(方法 + 路径):[例如 POST /api/orders]
接口用途:[它做什么]
请求体(JSON):[粘贴]
成功响应示例(JSON):[粘贴]
已知错误场景(如有):[列出或 none]
你的任务:
1) 检查仅从接口契约(contract)是否能看懂用途。
2) 找出缺失或含糊的请求字段。
3) 审阅响应结构的一致性与清晰度。
4) 至少给出 3 个真实可发生的错误响应(含状态码)。
5) 提出小幅命名/结构优化建议。
6) 输出一份干净、改进后的响应示例。
保持反馈务实、可直接落地。不要彻底重做整个 API 设计。
预期结果
你将获得清晰的改进建议、缺失的错误场景,以及更干净的响应示例。
实施步骤
1
粘贴接口信息
提供一个接口的用途、请求与响应示例。
3 分钟2
审阅 AI 反馈
查看建议修复点与缺失的边界情况。
3 分钟3
上线前应用改进
在发布前更新接口或文档。
5 分钟

