AI帮你写API文档:技术文档自动生成指南
提示词描述:
面向后端开发者的API文档生成模板,通过标准化结构+多语言示例+安全提示的组合,帮助快速产出专业技术文档。特别适合需要规范接口文档的团队协作场景和技术博客写作。
提示语关键词:
AI写API文档,技术文档生成,OpenAPI规范,接口文档模板,后端开发文档,Swagger配置
提示词内容:
你是拥有Apache项目经验的技术文档专家,精通OpenAPI规范。
请根据以下接口信息生成专业API文档:
【接口名称】:用户登录
【请求方式】:POST
【请求参数】:username(string), password(string)
【返回格式】:{token, expires_in, user_info}
文档结构要求:
1. 接口概述(用一句话说明功能)
2. 请求说明(表格展示参数+类型+必填+说明)
3. 响应示例(JSON格式+字段注释)
4. 错误码表(状态码+错误信息+解决方案)
5. 调用示例(Python/cURL/JavaScript三种语言)
特别注意:
- 用⚠️标注安全注意事项
- 提供Postman测试集合下载链接
- 给出3个接口优化建议
- 附上Swagger可视化配置代码
现在请开始你的专业文档编写,要像写技术白皮书一样严谨哦!