☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你是一名后端接口文档撰写工程师，正在为【订单查询接口】编写给第三方调用方看的对接说明。该接口已上线，url为https://api.example.com/v2/orders，使用bearer token认证。请严格按以下6个模块输出，顺序不可调整，每个模块标题用【】包裹，模块内不加小标题：【请求地址】【请求方式】【认证方式】【请求参数】【响应示例】【错误码说明】；请求参数需列出每个字段的英文名、中文名、是否必填、数据类型、示例值、说明（含边界限制）；响应字段同理，若为嵌套对象需逐层展开；该接口依赖上游用户中心服务，若用户token过期，返回401而非自定义错误码；订单号长度固定18位，由日期+流水号组成，首位不为0；签名算法采用hmac-sha256，密钥由我方后台分配，不可硬编码在前端；时间戳要求与服务器误差≤300秒，否则拒绝；提供一个能直接curl执行的完整请求示例（含header和body）。

写接口对接说明提示词，核心是让调用方一眼看懂请求怎么发、参数怎么填、返回怎么解析，而不是让chatgpt自己“发挥”。如果提示词只说“写个api文档”，生成内容往往缺字段类型、漏必填项、混淆请求体和查询参数，调用方拿到就卡在第一步。

明确接口角色与上下文

第一步，在提示词开头直接定义ChatGPT本次扮演的角色——不是通用助手，而是“对接文档撰写工程师”。

输入：“你是一名后端接口文档撰写工程师，正在为【订单查询接口】编写给第三方调用方看的对接说明。该接口已上线，URL为https://api.example.com/v2/orders，使用Bearer Token认证。”

这句必须写，否则ChatGPT默认按通用问答逻辑组织信息，容易把HTTP状态码混进业务错误码里，导致调用方误判超时还是权限问题。

强制结构化输出要求

方法一：用分隔符框定必须包含的模块

在提示词中加入：“请严格按以下6个模块输出，顺序不可调整，每个模块标题用【】包裹，模块内不加小标题：【请求地址】【请求方式】【认证方式】【请求参数】【响应示例】【错误码说明】”

方法二：用JSON Schema约束字段粒度

追加：“请求参数需列出每个字段的英文名、中文名、是否必填、数据类型、示例值、说明（含边界限制，如‘手机号仅支持11位纯数字’）；响应字段同理，若为嵌套对象需逐层展开。”

【不写清楚字段是否必填或类型，调用方会传空字符串代替null，导致服务端解析异常】

Ask Gemini/ChatGPT

用于在用户想通过浏览器自动化与 Google Gemini 或 ChatGPT 交互时。触发短语包括“ask Gemini”“ask ChatGPT”“ask GPT”“让...”。

下载

注入真实约束条件

第一步：指出当前接口实际依赖的外部条件

比如：“该接口依赖上游用户中心服务，若用户token过期，返回401而非自定义错误码；订单号长度固定18位，由日期+流水号组成，首位不为0。”

第二步：标注调用链路中的敏感环节

比如：“签名算法采用HMAC-SHA256，密钥由我方后台分配，不可硬编码在前端；时间戳要求与服务器误差≤300秒，否则拒绝。”

第三步：给出可验证的最小测试用例

比如：“提供一个能直接curl执行的完整请求示例（含Header和Body），确保调用方复制后修改token和order_id就能跑通。”

这一步操作起来很简单，直接把curl命令贴进去就行。但漏掉它，调用方就得自己拼Header、猜Body格式，80%的首次对接失败都卡在这儿。