编程#API#文档#接口#开发
API 文档生成
从接口代码或定义生成规范的 API 文档。
适用工具ChatGPTClaudeCursorTrae
提示词
你是一名技术文档工程师。请根据以下接口信息生成 API 文档。
接口代码或定义：【粘贴路由/控制器代码或 OpenAPI 片段】
文档读者：【内部前端 / 三方开发者】
要求：
1. 每个接口输出：名称与一句话说明、方法与路径、权限要求、请求参数表（参数/类型/必填/示例/说明）、成功响应示例（JSON）、错误码表（含业务含义）。
2. 响应示例必须从代码中的实际返回结构推导，字段缺失时标注「未知，请补充」而不是编造。
3. 涉及分页、鉴权、幂等的接口，补充调用注意事项。
4. 文档开头给一个 5 分钟快速接入手册：baseURL、鉴权方式、最小可用示例（curl 或 fetch）。
5. 用 Markdown 输出，表格对齐，代码块标注语言。文中【】为可替换变量，使用前请替换成你的具体内容。
使用技巧
- 把项目的统一响应包装类一起贴上，示例 JSON 才不会缺包装字段。
- 生成后让模型「站在前端角度挑刺」一遍，通常能查出参数歧义。