跳到主要内容

导入 OpenAPI (Swagger) 数据

  • 支持导入 OpenAPI 3 和 Swagger 2 数据格式的 json 或 yaml 文件。若在同一个接口中写了 summary、operationId、path 参数，那么在导入时接口名称将以 summary > operationId > path 优先级进行设置。

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

手动导入​

打开项目设置面板，轻点“导入数据（手动导入）”选项，你可以选择通过文件导入或 URL 导入。

文件导入​

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

URL 导入​

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

高级设置​

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

接口覆盖模式​

  1. 同 URL 覆盖：当两个文件 URL、method 相同时，新文件会覆盖旧文件。

  2. 同 URL 且同分组才覆盖：当两个文件的 URL、method 相同时，并且在同一个分组下时，新文件会覆盖旧文件。

  3. 同 URL 不导入：当两个文件 URL、method 相同时，新文件不会导入。

  4. 同 URL 时保留两者：当两个文件 URL、method 相同时，新文件会导入，旧文件不会被删除。

  5. 导入到分组：支持将文件导入到具体的分组中。

  1. 导入接口用例：开启开关后，已选择接口下的接口用例为默认全选状态，你也可以在导入预览中选择对应接口用例。

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

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

同步更新所在目录​

如果既需要将接口文档更新到 Apifox 中，又希望同步目录与 Swagger 内的文件夹保持同步，可以打开“同步更新所在目录”开关。

自动导入​

打开“项目设置”，轻点“导入数据（自动同步）”选项。你可以在此处设置多个数据源并定时同步到具体分组中。

注意

仅项目管理员具备“导入数据”（手动导入及自动导入）设置权限。

智能合并​

大部分用户通过导入 OpenAPI (Swagger) 数据，然后在 Apifox 中添加数据结构中文名、mock 规则、参数说明和接口返回示例；后端同学在 Swagger 中设计接口，其他成员在 Apifox 上维护、调试、测试接口。

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

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