导入 OpenAPI/Swagger

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

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

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

手动导入

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

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

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

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

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

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

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

智能合并：当两个文件的 Method 和 Path 相同时，将会保留旧文件内修改的中文名、Mock 规则、参数说明和接口的返回示例。

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

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

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

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

若导入非 Apifox 格式文件且接口文档被覆盖时，名称相同的接口用例不会导入。

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

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

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

大多数用户通过导入 OpenAPI/Swagger 数据，在 Apifox 中添加数据结构的中文名称、Mock 规则、参数说明和接口响应示例。后端开发人员在 Swagger 中设计接口，其他团队成员则在 Apifox 上进行接口的维护、调试和测试。

“智能合并” 功能可以避免在上述场景中导入接口时将数据源内所有字段完全覆盖的情况。

当你准备导入 OpenAPI/Swagger 数据的时候，在匹配相同接口时选择 “智能合并”，那么将会保留此前在 Apifox 内修改的中文名、Mock 规则、参数说明和接口的返回示例。