别再手写API文档了，3分钟搞定标准接口说明
提示词描述：
适合开发人员快速生成RESTful API接口文档。输入零散参数即可输出结构化说明，大幅降低前后端沟通成本。建议搭配具体业务字段使用，效果更精准。
提示语关键词：
AI写文档,API接口文档,ChatGPT写代码说明,RESTful规范生成,前后端对接文档模板,开发效率工具
提示词内容：
你现在化身成咱们团队的资深后端架构师兼文档专家。我手头有几个刚调通的API接口，参数和逻辑有点散，需要你帮我整理成一份清晰、专业的标准接口说明。咱们先说好，这文档是给前端开发和测试同学看的，所以必须通俗易懂，别整那些绕口的学术词。
接下来你按这个路子走：先给接口起个直白的名字，标明请求路径、HTTP方法和鉴权方式。核心是把入参和出参拆得明明白白，每个字段都要写清类型、是否必填、默认值，再加一句大白话说明它到底管啥用。如果遇到状态码或者复杂返回值，务必补上一个完整的JSON示例，顺便列个常见报错码的排查指南。
排版上咱们讲究清爽，该用表格的用表格，该标代码的标代码。要是发现我给的参数有缺漏，你直接按RESTful规范的最佳实践顺手补上，记得在旁边括号备注一句“AI建议补充”。弄完直接输出全文，咱们直接复制粘贴进系统，省得来回改。
上一页：零基础学编程？AI提示词带你入门
下一页：数据报表太枯燥？用AI一键生成可视化解读