写接口对接说明，本质上是让调用方拿到文档就能立刻知道请求怎么发、参数怎么填、返回怎么解析。如果提示词只丢一句“写个API文档”，ChatGPT生成的内容往往缺字段类型、漏必填项、把请求体和查询参数混在一起，调用方拿到手第一步就卡住。下面这套方法，我反复验证过几次，能确保输出结构清晰、没有歧义，你直接套用即可。

明确接口角色与上下文

第一步，在提示词开头直接告诉ChatGPT它扮演的是“对接文档撰写工程师”，而不是通用助手。比如这样写：
“你是一名后端接口文档撰写工程师，正在为【订单查询接口】编写给第三方调用方看的对接说明。该接口已上线，URL为https://api.example.com/v2/orders，使用Bearer Token认证。”
这一步不能省略，否则ChatGPT默认按通用问答逻辑组织信息，容易把HTTP状态码混进业务错误码里，导致调用方分不清是超时还是权限问题。

强制结构化输出要求

方法一：用分隔符框定必须包含的模块。在提示词中加上：
“请严格按以下6个模块输出，顺序不可调整，每个模块标题用【】包裹，模块内不加小标题：【请求地址】【请求方式】【认证方式】【请求参数】【响应示例】【错误码说明】”
方法二：用JSON Schema约束字段粒度。再追加：
“请求参数需列出每个字段的英文名、中文名、是否必填、数据类型、示例值、说明（含边界限制，如‘手机号仅支持11位纯数字’）；响应字段同理，若为嵌套对象需逐层展开。”
注意，如果不说清楚字段是否必填和类型，调用方可能会传空字符串代替null，导致服务端解析异常。

注入真实约束条件

第一步，指出当前接口实际依赖的外部条件。比如：
“该接口依赖上游用户中心服务，若用户token过期，返回401而非自定义错误码；订单号长度固定18位，由日期+流水号组成，首位不为0。”
第二步，标注调用链路中的敏感环节。比如：
“签名算法采用HMAC-SHA256，密钥由我方后台分配，不可硬编码在前端；时间戳要求与服务器误差≤300秒，否则拒绝。”
第三步，给出一个可验证的最小测试用例。比如：
“提供一个能直接curl执行的完整请求示例（含Header和Body），确保调用方复制后修改token和order_id就能跑通。”
这一步操作起来很简单，直接把curl命令贴进去就行。但漏掉它，调用方就得自己拼Header、猜Body格式——80%的首次对接失败都卡在这里。