程序员可用ChatGPT自动生成规范API文档：先整理含请求方法、URL、请求头、参数及响应结构的接口原始信息，按模块分组后，用结构化提示词触发生成，再通过修正类型、格式化JSON、统一鉴权头等方式优化，最终导出为带YAML元数据的Markdown文档。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
程序员需要快速产出准确、可读性强的API接口文档，但手动编写耗时易错，用ChatGPT自动生成能大幅缩短交付周期，尤其适合前后端联调前急需文档支撑的场景。
准备原始接口信息
先整理好待文档化的接口原始材料：至少包含请求方法（GET/POST）、完整URL路径、请求头示例（如 Authorization: Bearer xxx）、请求体（JSON格式）或查询参数、响应体结构（含字段名、类型、是否必填、示例值）。【缺失响应字段说明会导致生成文档中出现“未知用途”“暂未定义”等模糊描述】
把所有接口按功能模块分组，比如「用户管理」「订单操作」「支付回调」，每个模块单独建一个文本块，避免混在一起让模型混淆上下文。
构造精准提示词
在ChatGPT中输入以下结构化提示，替换方括号内内容为你的实际信息：
你是一名资深后端工程师，正在为内部团队编写正式API文档。请严格按以下要求输出：① 使用中文；② 每个接口单独成节，标题格式为「### [接口名称]」；③ 包含「接口说明」「请求方式」「请求URL」「请求头」「请求参数（表格：参数名｜类型｜是否必填｜说明）」「响应示例（格式化JSON）」「响应字段说明（表格：字段名｜类型｜说明）」；④ 不添加任何额外解释、不写“注意”“提示”类文字；⑤ 字段说明必须具体，禁止出现“同上”“见上文”等指代。
接下来是第一个接口：[粘贴你整理好的第一条接口原始信息]
优化生成结果
方法一：对生成文档中字段类型错误（如把字符串写成integer）或必填标识错误的地方，直接复制该字段所在行，加一句“请将‘类型’改为string，‘是否必填’改为‘是’”，重新发送给ChatGPT。
用于在用户想通过浏览器自动化与 Google Gemini 或 ChatGPT 交互时。触发短语包括“ask Gemini”“ask ChatGPT”“ask GPT”“让...”。
方法二：发现响应示例JSON缩进混乱或缺少换行，选中整段JSON → 粘贴到 VS Code 中 → 按 Shift+Alt+F 格式化 → 再复制回ChatGPT，追加指令：“请严格使用此格式化后的JSON作为响应示例，不要改动字段名和值”。
方法三：若多个接口共用同一套鉴权头，但生成文档里每条都重复写一遍，可在最后统一追加指令：“所有接口的‘请求头’部分统一简化为：Authorization: Bearer {token}（JWT格式），不再展开示例值”。
导出为标准Markdown文档
第一步：全选ChatGPT生成的文档内容 → 复制 → 新建 .md 文件 → 粘贴。
第二步：在文档开头插入 YAML 元数据块：# API文档版本：v1.2.0
生成时间：2024-06-15
维护人：your_name
第三步：检查所有「### 接口名称」是否被正确识别为三级标题——若部分被渲染成普通文本，手动在每行前加三个#并保留空格，例如 ### 用户登录。
第四步：用 Typora 或 Obsidian 打开该 .md 文件 → 导出为 PDF 或 HTML，即可交付给测试与前端同事使用。
