新手应使用填空式模板:【code】:1002;【message】:手机号已被注册;【reason】:用户提交的手机号已在系统中存在;param: phone。文档片段示例:客户端请求错误。错误码 1002:手机号已被注册。(用户提交的手机号已在系统中存在;关联参数:phone)
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

新手在Trae中写API错误码说明时,常把HTTP状态码、业务码、消息文本混在一起写,导致前端看不懂哪部分可捕获、哪部分该展示给用户。你需要一个填空式模板,字段明确、顺序固定、带真实示例,照着替换就能用。
基础三字段模板(必填)
第一步:在API响应文档或代码注释中,按顺序写出以下三个字段,用英文冒号+空格分隔:
【code】:填数字型业务错误码,如1002,不是HTTP状态码;HTTP 400/500等由网关统一返回,这里不写。
【message】:填中文提示语,面向终端用户,不出现变量名、字段名、技术术语;例如“手机号已被注册”,不能写“phone already exists”或“user.phone duplicate”。
【reason】:填一句话原因,面向前端开发者,说明触发条件和修复方向;例如“用户提交的手机号已在系统中存在”,不要写“服务端校验失败”这种废话。
带场景的进阶模板(选填)
当错误涉及具体参数或权限时,在基础三字段后追加:
method一:加param字段——仅当错误由某个请求参数直接引发时才加,例如手机号格式错、ID为空。格式为param: phone,不加引号、不写值、只写参数名。
method二:加scope字段——仅当错误因权限不足导致,例如“无权删除他人订单”。格式为scope: order:delete:own,用英文冒号分隔资源、动作、归属范围。
注意:param和scope二者不可同时出现,选其一即可;多参数错误仍只写一个最核心的param。
生成可读性更强的文档片段
把上面字段组合成一段自然语言描述,用于OpenAPI或内部Wiki:
① 先写HTTP状态码(固定为400或403或404),加中文说明:“客户端请求错误 / 权限不足 / 资源不存在”。
② 接着换行写业务错误码和message:“错误码 1002:手机号已被注册”。
③ 最后用括号补充reason和可选字段:“(用户提交的手机号已在系统中存在;关联参数:phone)”。
这一步操作起来很简单,直接把三字段按顺序粘贴进接口文档的“错误响应”章节就行,不用额外改句式。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











