你是一名API文档工程师,需为前端提供可直接落地的错误码说明:每条须含是否需重试、是否污染本地状态、用户修复指引;按「用户看到什么→做了什么→系统拦在哪一步→应提示什么」四段式描述;禁止使用“校验失败”等黑盒表述,必须绑定具体接口路径与用户动作。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让Trae生成的API错误码说明文档能被前端同事一眼看懂、快速查错、不翻源码就能对接,而不是堆砌抽象术语或照搬HTTP状态码定义。
用真实调用场景锚定错误描述
在提示词开头直接嵌入一个前端真实报错截图里的请求上下文:「前端调用 POST /api/v1/orders 时收到响应 {“code”: 4002, “msg”: “invalid promo_code”},但文档里只写了“优惠码无效”,没说明 promo_code 是空字符串、格式错误还是已过期」。
要求Trae基于该实例反向推导出错误码说明的颗粒度:必须区分「空值校验失败」「正则匹配失败」「数据库查无此码」「有效期已过」四类子因,并为每类标注典型请求体示例。
这一步跳过泛泛而谈的“请写清楚错误原因”,而是用具体失败现场倒逼输出可操作性内容。
强制绑定业务动词与错误路径
方法一:在提示词中列出3个高频出错接口路径,每个后面紧跟真实用户动作:
• POST /api/v1/payments → 用户点击“立即支付”按钮后弹窗提示“余额不足”
• PUT /api/v1/profile → 用户修改头像后上传失败,控制台显示“file_size_exceed”
• GET /api/v1/coupons → 用户下拉刷新领券页,返回“rate_limit_exceeded”
PigX UI Pro 前端开发指南 - Vue 3 + TypeScript + Element Plus。当用户提到 PigX UI、PigX 前端、lgb-mgui 项目、Vue 3 企业级后台开发、Element Plus 后台开发时使用此技能。
要求Trae为每个错误码生成「用户看到什么→做了什么→系统拦在哪一步→应提示什么文案」四段式说明,禁止出现“服务端校验不通过”这类开发视角表述。
【关键前提】所有错误码必须对应到具体HTTP方法+路径+用户端触发动作,否则视为无效输出
注入前端协作语言习惯
第一步:声明角色与协作身份——“你是一名API文档工程师,过去三年专职为Web和iOS团队编写错误码手册,熟悉前端同学查文档时最常跳过的三类信息:是否需要重试、是否要清缓存、是否需引导用户操作”。
第二步:指定输出字段——每条错误码说明必须包含:前端是否需主动重试(是/否)、是否涉及本地状态污染(如token失效需清除localStorage)、用户侧可感知的修复指引(例:“请检查网络后重新下单”“退出登录再试一次”)。
第三步:禁用词汇黑名单——在提示词末尾明确排除:“禁止使用‘校验失败’‘逻辑异常’‘服务不可用’等黑盒表述;‘500’不能只写‘服务器错误’,必须写明‘订单创建事务回滚,当前下单已取消,请重新提交’”。

















