Copilot接口文档必须严格按四层结构输出:①接口概览;②请求说明(URL参数、Header、Body三栏表格);③单行纯JSON响应示例;④错误码表(code|message|触发场景),并用###或全角分隔线锚定区块,禁混表、禁注释、禁模糊描述。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让 Microsoft Copilot 生成的接口文档结构清晰、层级分明,能一眼区分请求路径、参数说明、响应示例和错误码,而不是堆成一段文字或混杂 Markdown 表格与自由描述。
先锁定四层主干结构
在提示词最开头直接写:“【必须严格按以下4层输出】:①接口概览(含路径、方法、简要用途);②请求说明(分URL参数、Header、Body三栏表格);③响应示例(只输出纯 JSON,不加注释、不缩进、不换行);④错误码表(字段:code|message|触发场景)。”
Copilot 对开头的“必须严格按以下X层”指令最敏感,漏掉“必须”二字,它大概率会把 Header 和 Body 合并在一段里写;漏掉“不加注释、不缩进、不换行”,JSON 示例就会带空格和多行缩进,无法直接粘贴进 Swagger 或 Postman。
这一步操作起来很简单,直接复制上面那句带编号的结构声明粘贴到提示框第一行就行。
用符号锚点强制分段落
方法一:插入三重井号分隔符
在提示中明确写:“每个大区块前必须加### [区块名],例如### 接口概览、### 请求说明、### 响应示例、### 错误码表。”
Copilot 识别 ### 的稳定性远高于“———”或“***”,且中文方括号[区块名]能防止它擅自改成英文标题。
方法二:绑定分隔线样式
写:“所有输出必须包含四处固定分隔线:———【接口概览】———、———【请求说明】———、———【响应示例】———、———【错误码表】———。每处之后紧接对应内容,不得省略分隔线,不得在分隔线前后加空行。”
【注意】分隔线必须带中文全角破折号和中文括号,Copilot 对“--- Request ---”识别失败率超40%。
Outlook 日历 / Microsoft 365 日历 SECURE API CLI。当用户需要列出、搜索或读取 Outlook / Microsoft 365 日历事件,以及创建……
禁用扁平化输出的负向指令
第一步:列出 Copilot 高频越界行为
在提示末尾追加:“禁止行为:①把 URL 参数和 Body 字段混在同一张表里;②在响应示例中插入 // 注释或换行缩进;③错误码表里出现‘请检查 token’这类模糊描述;④接口概览中夹带 curl 命令或 Python 示例。”
第二步:绑定后果描述
“若违反任一禁止行为,输出视为无效,需重新生成。”
这句不是客套话——Copilot 会主动规避被标记为“无效”的输出模式,尤其当“curl 命令”“// 注释”等关键词出现在禁止列表中时,它几乎不会再生出带这些元素的内容。
字段级控制确保表格可用
第一步:指定表头格式
写:“请求说明表格列名必须为:参数名|位置|类型|是否必填|说明,全部使用中文全角|分隔,不加表头编号,不加‘字段’‘取值’等冗余字。”
第二步:约束单字段深度
例如写:“access_token:Header,字符串,必填,用于身份校验 → 输出时仅填‘字符串’,不展开‘JWT 格式,有效期2小时’。”
这样 Copilot 就不会把业务规则塞进“类型”栏,破坏表格对齐。
第三步:强控响应体纯净度
写:“响应示例必须为单行纯 JSON,例如{"code":0,"data":{"id":123}},禁止换行、禁止缩进、禁止添加任何文字前缀(如‘返回结果:’)。”
【关键前提】必须用英文双引号+反斜杠转义,Copilot 才认作 JSON 字面量;写成中文引号或不转义,它会当成普通文本处理。

















