用AI写API文档：5分钟生成专业接口说明
提示词描述：
帮助开发者快速生成专业级API文档的提示词模板。适用于后端开发、前后端协作、开源项目维护等场景。支持RESTful、GraphQL等多种接口风格，能自动生成参数说明、错误码、多语言示例等完整文档内容。
提示语关键词：
AI写API文档,接口文档生成,ChatGPT编程提示词,API文档模板,Swagger文档生成,后端开发效率,技术文档自动化
提示词内容：
【使用场景】
开发完一个API接口后，需要快速生成清晰、完整的技术文档。这个提示词能帮你自动解析代码逻辑，生成包含请求参数、响应格式、错误码、使用示例的标准化API文档，大幅提升文档编写效率。
【操作步骤】
第一步：提供API的核心代码或接口定义。包括路由、参数、返回数据结构等关键信息。
第二步：指定文档格式要求。告诉AI你需要的文档结构，比如RESTful风格、GraphQL风格，或者公司内部的文档模板。
第三步：补充业务背景。简要说明这个API的业务场景和使用方，帮助AI生成更贴切的描述。
第四步：要求生成多语言示例。让AI同时提供curl、Python、JavaScript等多种调用示例。
【效果示例】
输入：一个用户登录接口的代码片段
输出：包含接口说明、请求参数表、响应示例、错误码列表、多语言调用示例的完整Markdown文档
【进阶技巧】
可以让AI根据Swagger/OpenAPI规范生成JSON Schema；对于复杂接口，建议先让AI画出数据流向图再写文档；还可以批量处理多个接口，生成统一的API文档集合。