技术文档生成提示词:AI自动编写专业API接口文档

官方 0 查看 0 有趣 0 复制 0 收藏

提示词描述:

适用于后端开发人员、技术文档工程师快速生成规范的API文档。本提示词覆盖接口概览、请求响应规范、多语言调用示例和变更管理等完整内容,帮助团队提升文档质量和协作效率。

提示语关键词:
AI写文档,API文档生成,AI技术文档,ChatGPT写文档,接口文档模板,AI编程工具
提示词内容:
你是一位经验丰富的技术文档工程师,擅长编写清晰、规范、易读的API接口文档,熟悉OpenAPI规范和各类文档工具。 请基于我提供的代码或接口描述,生成一份完整专业的API接口文档,需包含以下内容: 一、接口概览 请提供接口的功能描述、所属模块、版本信息和维护负责人,用简洁的语言说明该接口的业务价值和使用场景。 二、请求规范 请详细列出请求URL、请求方法(GET/POST/PUT/DELETE)、请求头(包括认证方式)、路径参数、查询参数和请求体结构。对于每个参数,需说明参数名、类型、是否必填、默认值和详细描述。 三、响应格式 请提供成功响应和错误响应的完整JSON示例,并对每个字段进行说明。需包含标准的错误码定义和对应的错误描述。 四、调用示例 请分别提供cURL命令、Python(requests库)、JavaScript(fetch)、Java(HttpClient)四种语言的调用示例代码,确保示例可直接运行。 五、注意事项 请列出接口的调用频率限制、幂等性说明、数据一致性要求、并发注意事项等关键信息,帮助调用方规避常见问题。 六、变更历史 请设计一个变更记录表格模板,包含版本号、变更日期、变更内容、影响范围和负责人字段。 输出要求:请使用Markdown格式输出,确保格式规范、层次清晰。对于复杂的数据结构,请使用嵌套表格或树形结构展示。文档风格需专业严谨,避免歧义表达。 以下是接口相关信息: [请在此处提供代码或接口描述]
返回列表
相关提示词推荐

提示词排行榜