导入 OpenAPI (Swagger) 数据

支持导入 OpenAPI 3 和 Swagger 2 数据格式的 json 或 yaml 文件。

若在同一个接口中写了 summary、operationId和path 参数，那么在导入时接口名称将以 summary > operationId > path 的优先级进行设置。

支持导入 OpenAPI 扩展，点击此文档查看 Apifox 所支持的接口字段。

提示

详细的教程，请参考这篇最佳实践：之前使用 Swagger 来管理 API，如何迁移到 Apifox？

手动导入

打开 “项目设置” 面板，点击“导入数据”选项，你可以选择通过“上传文件”导入或 “URL 方式” 导入。

文件导入

你可以将 json 或 yaml 文件拖拽到下图区域中导入文件。

URL 导入

使用 URL 导入方式时需填写 json 或 yaml 数据文件的 URL（直链），而并非 Swagger UI 的 URL。

高级设置

导入 OpenAPI/Swagger 格式只包含接口、数据模型和环境。

接口覆盖模式

导入文件时可选择如下的设置：

1. 导入到目录：支持将文件导入到具体的目录中。

2. 覆盖已有接口：当两个文件的 Method 和 Path 相同时，新文件会覆盖旧文件。

3. 智能合并：当两个文件的 Method 和 Path 相同时，将会保留旧文件内修改的中文名、Mock 规则、参数说明、请求示例、响应示例等信息。

4. 覆盖指定字段：当两个文件的 Method 和 Path 相同时，可选择覆盖指定字段。其他未选中字段会保留 Apifox 中的现有数据。

5. 不导入：当两个文件的 Method 和 Path 相同时，新文件不会导入。

6. 保留两者：当两个文件的 Method 和 Path 相同时，新文件会导入，旧文件不会被删除。

7. 导入接口用例：启用该选项后，所勾选接口下的接口用例将默认跟随全选，你也可以在导入预览中手动选择相应的接口用例。

“数据模型” 需单独进行设置并选择覆盖模式、导入的目录。

更新接口所在目录

如果在导入文件后，希望将 Apifox 中的现有接口调整为与导入的 Swagger 目录结构保持一致，可以启用“更新接口所在目录”选项，以更新现有目录结构。

定时导入

打开 “项目设置”，点击 「导入数据 -> 定时导入」 选项。你可以在此处设置多个数据源并定时同步到具体目录中。