API 文档提示词解决的是接口写完却迟迟没人补文档的拖延：代码已经上线，调用方却只能翻源码猜参数，联调时反复来问类型、必填和错误码。下面这段提示词可以直接复制，把接口代码或接口定义贴进去，再填好读者和输出格式，AI 会按调用方真正查文档的顺序，输出用途、参数表、请求示例、返回示例和错误码说明，拿到手核对字段就能发出去。
先说清这段提示词适合什么情况
适合已经有代码、只是缺文档的接口：后端接口写完要交给前端或第三方联调，老项目补文档，新人接手前先摸清一批接口的入参和出参。它不能替代你确认业务规则，代码里没写清的校验逻辑、权限要求和限流数值，AI 只能标出存疑，不能替你编。如果接口还在频繁改字段，先只生成参数表部分，等字段稳定后再补示例，省得文档刚写完就过期。
可直接复制的提示词正文
你是一名接口文档编辑。请根据我贴出的接口代码或接口定义，为这个接口写一份调用方能直接照着联调的文档。
接口代码或定义：{{接口代码}}
文档读者：{{读者}}
鉴权方式：{{鉴权方式}}
基础地址说明：{{基础地址}}
输出要求：
1. 先用两句话写清这个接口做什么、什么时候调用，不要复述代码。
2. 再列参数表，逐个参数写明名称、位置（路径、查询、请求头或请求体）、类型、是否必填和含义；代码里看不出的含义标为待确认，不要猜。
3. 给一个完整的请求示例和一个成功返回示例，字段名和类型与代码完全一致，示例值用脱敏的假数据。
4. 单独列错误码说明：把代码里实际抛出的错误逐个列出，写明触发条件和调用方该怎么处理；代码里没有的错误码不要补。
5. 最后列一节存疑清单，把代码里没有写清的校验规则、权限要求和边界情况逐条列出，等我确认后再写进正文。可替换变量怎么填
- 接口代码：贴处理函数、路由定义和相关的请求与返回结构体，不要只贴一个函数名；上下文越完整，参数表越少出现待确认。
- 读者：写清是公司内部前端、外部合作方还是新入职的后端。读者不同，示例的详细程度和要不要解释业务词，差别很大。
- 鉴权方式：写明用令牌、签名还是网关统一鉴权；没有鉴权就直接写无，不要留空让 AI 默认补一段鉴权说明。
- 基础地址：只写环境说明，例如测试环境与正式环境分开，不要把真实密钥、真实域名凭据写进提示词。
拿到初稿后，先核对这三处
第一，逐个字段对代码。AI 偶尔会把可选参数写成必填，或者给示例加上代码里不存在的字段，参数表必须和结构体逐字对一遍。第二，看错误码有没有被补全得过头：凡是代码里搜不到的错误码和状态码，一律删掉或移到存疑清单。第三，示例里的假数据要彻底脱敏，手机号、邮箱、订单号都换成明显虚构的值，别把联调时用的真实数据原样留在文档里。
同一批接口要批量补文档时，一次只贴一个接口生成一份，字段口径才稳；一次贴十个接口，参数表很容易互相串味。生成顺序可以反过来用：联调时对方报参数对不上，先用调试提示词：把报错和代码贴给 AI，一次拿到根因定位是文档写错还是调用写错，再回来改这一页文档。
