许多开发同事都曾遇到一个令人头疼的问题:让 Copilot 编写接口对接文档时,它虽然完成了基本内容,却常常遗漏签名算法、超时阈值、重试策略等关键细节。结果开发同事反复追问,一来一回效率大打折扣。
经过多次实际磨合,我们总结出几条高效套路,能让 Copilot 完整且规范地输出文档。下面逐一拆解。
明确告诉 Copilot 你需要的格式
在提示词开头,直接写明输出结构。例如:
“请按以下结构输出:【1. 接口地址】→【2. 请求方法】→【3. 请求头(含鉴权字段)】→【4. 请求体示例(JSON 格式,字段名加注释)】→【5. 响应成功示例】→【6. 常见错误码及含义】→【7. 特别注意项(必须包含签名生成步骤、超时阈值、重试策略)】”。
这一步千万不能省略。Copilot 的逻辑很简单——你没有写进提示词的结构,它不会主动补全。它只响应你明确提出的内容,不存在自动联想补齐遗漏项的功能。

用占位符锁定关键信息位置
在请求体或响应体示例中,对不可省略的核心字段直接使用大写占位符。例如:
"timestamp": "UNIX_TIMESTAMP_MS", "sign": "SHA256(app_key+app_secret+timestamp+nonce)", "timeout_ms": 3000。
占位符本身虽然不是真实值,但它像一根绳子,牢牢约束 Copilot 必须保留这些字段并标注计算逻辑。否则它很容易将此类信息简化为“其他参数”四个字一笔带过。
【签名字段必须附带计算公式,否则 Copilot 会默认写成“sign: string”】
给 Copilot 提供一个最小但完整的样例
有两种实用方法可以尝试。
方法一:直接粘贴一份你已经确认过的旧接口说明(即使只有三行),并在前面加一句:“以下为标准格式参考,请严格按此风格和字段粒度生成新接口说明:”。
方法二:用表格清晰列出字段清单。例如:
| 字段名 | 类型 | 必填 | 说明 | 示例 |
|--------|------|------|------|------|
| nonce | string | 是 | 随机字符串,防重放攻击 | “a1b2c3d4” |
| sign | string | 是 | SHA256(app_key+app_secret+timestamp+nonce) | “e8f7...” |
Copilot 对表格的理解能力相当强,比纯文字描述更能锚定字段的层级和约束条件。简单来说,表格就是它的“硬锚点”。
禁止模糊表述,替换所有“相关”“某些”“一般”
第一步:将提示词中所有“相关参数”“部分字段需签名”“一般建议设置超时”等模糊表达全部删除。
第二步:替换为确定性指令。“所有请求必须携带 nonce 字段,长度为 8~32 位小写字母加数字组合,服务端校验到重复请求将直接拒绝”。
第三步:对超时时间写死具体数值。“HTTP 连接超时设为 1500ms,读取超时设为 2500ms,超出即断开并返回 504”。
Copilot 根本不处理概率性语言。你写“一般”,它就当作可选项直接跳过。只有把话说到“必须”“一定”“写死”的份上,它才会老老实实遵照执行。
