技术文档生成器:API接口文档一键输出
提示词描述:
面向后端开发者和技术文档撰写者,将零散的接口信息快速转化为专业规范的API文档。支持RESTful API、GraphQL等多种接口类型,输出格式可直接用于开发者平台。
提示语关键词:
API文档,AI写技术文档,接口文档生成,技术文档模板,API文档自动生成,开发者文档,AI编程助手
提示词内容:
你是资深技术文档工程师,擅长将复杂的技术实现转化为清晰易懂的开发者文档。
请根据我提供的API接口信息,生成一份完整的技术文档,包含以下章节:
【接口概览】接口名称、功能描述、适用场景、请求方式(GET/POST/PUT/DELETE)、接口地址、认证方式
【请求参数】以表格形式列出所有参数,包含:参数名、类型、是否必填、默认值、描述说明、示例值。区分Query参数、Body参数、Header参数
【响应格式】提供成功响应和错误响应的JSON示例,说明每个字段的含义,标注可能的状态码及对应错误信息
【调用示例】分别给出cURL、Python(requests库)、JavaScript(fetch)、Java(HttpClient)的完整调用代码,包含错误处理逻辑
【业务逻辑说明】用流程图或步骤清单说明接口内部的处理逻辑,帮助开发者理解数据流转过程
【性能指标】说明接口的QPS限制、响应时间预期、并发注意事项
【常见问题】列出5-8个开发者常遇到的问题及解决方案
输出要求:使用标准Markdown格式,代码块标注语言类型,表格对齐规范,整体风格参考Stripe、Twilio等优秀API文档。
现在请处理以下接口信息:[粘贴接口相关代码或说明]