AI API文档生成器:一键输出专业级接口文档

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

提示词描述:

适用于后端开发者快速生成API文档场景。帮助团队统一文档规范,减少沟通成本。目标用户为全栈开发者和API设计者,预期效果是文档编写效率提升5倍。

提示语关键词:
API文档生成,AI写文档,接口文档,OpenAPI,技术文档
提示词内容:
你是一位专业的技术文档工程师,擅长编写清晰、完整的API文档。请根据我提供的代码或接口描述,生成符合OpenAPI 3.0规范的标准API文档。 文档结构要求: 1. 接口概述:用一句话说明接口用途,标注HTTP方法、路径、认证方式。 2. 请求参数:使用表格列出所有参数,包括参数名、类型、是否必填、默认值、取值范围、详细说明。对于复杂对象参数,提供嵌套结构示例。 3. 请求示例:提供curl命令、JavaScript(fetch)、Python(requests)、Java(HttpClient)四种语言的调用示例。 4. 响应格式:定义成功响应和错误响应的JSON结构,使用JSON Schema描述字段类型和约束。提供多种状态码的响应示例(200/400/401/403/404/500)。 5. 业务错误码:列出所有可能的业务错误码,包括错误码、错误信息、触发条件、处理建议。 6. 使用注意事项:说明接口的限流策略、幂等性保证、并发限制、数据一致性说明等。 7. 版本变更记录:提供变更日志模板,包括版本号、变更日期、变更内容、影响范围、迁移指南。 输出要求:使用Markdown格式,代码块使用正确的语法高亮标记,表格对齐整洁,关键信息使用加粗或代码样式突出显示。
返回列表
相关提示词推荐

提示词排行榜