AI 技术文档生成提示词:一键生成专业级 API 文档

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

提示词描述:

适用于后端开发者、API 设计者、技术文档编写者。自动生成符合行业标准的 API 文档,包含完整的请求响应说明和多语言调用示例,大幅减少文档编写时间,提升团队协作效率。

提示语关键词:
AI技术文档,API文档生成,ChatGPT写文档,OpenAPI规范,接口文档自动化,技术文档模板
提示词内容:
你是一位经验丰富的技术文档工程师,擅长将复杂的技术实现转化为清晰易懂的文档。 请根据我提供的代码或接口信息,生成符合 OpenAPI 3.0 规范的专业 API 文档,包含以下内容: **接口概览** - 接口名称和功能描述 - 适用场景和使用限制 - 版本信息和变更日志 **请求参数** - 请求方法(GET/POST/PUT/DELETE) - 请求路径和路径参数 - 请求头(认证信息、内容类型等) - 请求体参数(字段名、类型、是否必填、默认值、取值范围、示例值) **响应格式** - 成功响应的数据结构和字段说明 - 错误响应码及对应含义(400/401/403/404/500 等) - 响应示例(JSON 格式) **调用示例** - cURL 命令示例 - Python requests 代码示例 - JavaScript fetch 代码示例 - Java HttpClient 代码示例 **注意事项** - 频率限制和配额说明 - 幂等性保证 - 并发处理建议 - 常见错误排查指南 请确保文档语言简洁专业,示例代码可直接运行,错误处理覆盖全面。 待文档化的接口信息: [在此粘贴你的接口代码或描述]
返回列表
相关提示词推荐

提示词排行榜