AI智能提取API文档
功能概述
AI智能提取API文档是一个集文档生成、接口调试、Mock服务一体化的智能工具,支持用户通过粘贴文档内容,一键生成标准化的API文档,并可直接进行接口调试与模拟返回。该功能极大提高了文档处理效率,提升了团队协作与开发流畅度。
操作步骤
1. 打开功能入口
- 在“API管理”模块的新建操作中选择
AI 智能提取 API
,点击后将直接打开提取弹框入口。 - 或在“API管理”模块默认页面中,直接能够找到
AI 智能提取 API
入口。
2. 粘贴文档信息
如果你手头是 Word 等格式的离线API文档,请:
- 复制文档中的接口内容(支持接口说明、请求方式、URL、参数、响应等结构)
- 粘贴至工具提供的输入区域。
(例如:选择开放平台的OpenAPI进行文档粘贴
3. 自动识别与生成中
粘贴内容并点击生成
按钮后,系统将自动打开右侧的 “AI 智能提取 API 文档-生成中”抽屉,展示正在解析的进度。无需手动操作,等待系统完成API信息的识别与结构化。
4. 查看生成结果
- 生成过程中,页面将展示格式化后的接口文档信息,支持编辑修改。
- 生成完成后,点击页面右上角的
保存
按钮,即可对接口文档进行分享或调试。
5. 接口调试 & Mock服务使用
系统已自动解析接口参数及响应格式,支持你直接在页面内进行调试。
- 自动生成可访问的 Mock URL,供前端开发直接使用
- 自动生成在线API文档
- 自动生成调试接口
常见使用场景
场景 | 操作方式 | 预期收益 |
---|---|---|
收到 Word 接口文档 | 复制内容粘贴到输入框,点击“生成” | 快速结构化,节省文档梳理时间 |
获取一份 Swagger 文档链接 | 粘贴文档信息 | 自动提取接口信息,形成规范格式 |
前端需 Mock 接口 | 直接使用生成的 Mock 地址 | 无需等待后端,前端可并行开发 |
API 调试 | 在文档页中直接测试接口 | 无需切换工具,一键调试 |
注意事项
- 粘贴内容请尽可能保持接口结构完整(如:请求方式、URL、参数、响应结构),以提升AI识别准确性
- 当前版本暂不支持扫描图片中的API内容
- 若AI识别不准确,可手动补充后再生成引用文档