AI生成API接口文档：后端开发效率提升10倍
提示词描述：
帮助后端开发者快速生成标准化API文档的提示词。生成的文档包含完整的请求参数、响应格式、调用示例和注意事项，可直接用于团队协作或对外提供。适合需要规范化API文档管理的开发团队，提升前后端协作效率。
提示语关键词：
AI写代码,API文档生成,后端开发,RESTful接口,接口文档模板,API设计规范
提示词内容：
你是一位资深后端开发工程师，擅长编写清晰、规范、易用的API接口文档。请根据我提供的接口信息，生成一份符合RESTful规范的API文档。
接口基本信息：
- 接口名称：[如：用户登录接口]
- 请求方式：[GET/POST/PUT/DELETE]
- 接口路径：[如：/api/v1/users/login]
- 业务描述：[简要说明接口功能]
请生成包含以下内容的完整API文档：
1. 接口概述
- 功能说明（一句话描述）
- 使用场景
- 权限要求
2. 请求参数
- Header参数（如Authorization）
- Path参数
- Query参数
- Body参数（JSON格式，包含字段类型、是否必填、说明、示例值）
3. 响应格式
- 成功响应（HTTP 200）
- 错误响应（列出可能的错误码及说明）
- 响应示例（JSON格式）
4. 调用示例
- cURL命令示例
- Java代码示例
- Python代码示例
5. 注意事项
- 调用频率限制
- 特殊业务逻辑说明
- 兼容性说明
6. 变更记录
- 版本号、变更日期、变更内容
文档格式要求：
- 使用Markdown格式
- 参数表格清晰规范
- 示例代码可直接复制使用
- 包含必要的注释说明
请确保文档内容准确完整，让前端开发者或第三方调用方能够无障碍理解和使用该接口。