你现为某大厂api平台组资深文档工程师,负责输出符合openapi 3.0规范的错误码说明。所有输出必须包含且仅包含以下5个字段:①错误码(如err_user_not_found);②http状态码(如404);③触发条件(精确到参数校验/权限/资源状态等层级);④错误响应示例(json格式,含code/message字段);⑤客户端处理建议(动词开头,如‘重试前检查token有效期’)。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让豆包AI生成一份API错误码说明文档,但发现它常漏掉HTTP状态码、错误场景描述、客户端处理建议等关键字段,导致文档无法直接交付给前端或测试团队使用。
先用角色+规则锚定强制结构输出
在新对话开头输入:“你现为某大厂API平台组资深文档工程师,负责输出符合OpenAPI 3.0规范的错误码说明。所有输出必须包含且仅包含以下5个字段:①错误码(如ERR_USER_NOT_FOUND);②HTTP状态码(如404);③触发条件(精确到参数校验/权限/资源状态等层级);④错误响应示例(JSON格式,含code/message字段);⑤客户端处理建议(动词开头,如‘重试前检查token有效期’)。”
这一步锁死字段维度,避免AI自由发挥跳过任意一项。若后续发现某字段缺失,说明角色绑定未生效,需重启会话重输该句。
再用分项反问法触发自查
方法一:粘贴AI已生成的错误码条目后,追加提问:“请逐项核对:这一条是否提供了HTTP状态码?若未提供,请补全并说明依据(如401必须对应未认证,不可填200)。”
方法二:针对“客户端处理建议”易遗漏的问题,单独聚焦提问:“这条错误码的客户端处理建议是否可执行?请判断:建议是否含具体动作动词?是否指向明确对象(如‘刷新access_token’而非‘检查权限’)?若任一否,请重写。”
【注意:不要只问“有没有建议”,要定义可验证标准】
最后用负向排除法堵住逻辑漏洞
第一步:提供正确样例并标注:“正确示例→ERR_INVALID_PARAM:400;触发条件:name字段为空字符串或长度超过32字符;响应示例:{‘code’:‘ERR_INVALID_PARAM’,‘message’:‘参数name格式不合法’};客户端处理建议:校验前端表单非空及长度限制。”
第二步:提供典型错误样例并点明原因:“错误示例→ERR_TIMEOUT:504;触发条件:后端服务调用超时;响应示例:{‘code’:‘ERR_TIMEOUT’,‘message’:‘请求超时’};客户端处理建议:稍后重试。(问题:未说明超时阈值、未区分是网关超时还是下游服务超时、建议未提示是否应降级)。”
第三步:发送待检内容,并指令:“请对照以上正误样例,指出本条缺失的字段或表述缺陷,仅输出问题点,不重写全文。”
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











