导入数据

    打开 项目设置 面板,点击 手动导入 ,可选择文件导入或 URL 导入。

    以导入 Apifox 格式为例,导入可选内容包括:接口、数据模型、环境、测试用例、测试套件

    注意

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

    2. 导入 Postman 格式只包含 接口

    导入数据 - 图2

    手动导入-高级设置

    1. 接口覆盖模式

      1. 同 URL 覆盖:当两个文件 URL、method 相同时,新文件会覆盖旧文件

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

      3. 同 URL 不导入:当两个文件 URL、method 相同时,新文件不会导入

    2. 文件(markdown 文档、数据模型、测试用例、接口用例)覆盖模式

      1. 同名覆盖:当两个文件名称相同时,新文件会覆盖旧文件

      2. 同名且同分组才覆盖:当两个文件的名称相同时,并且在同一个分组下时,新文件会覆盖旧文件

      3. 同名不导入:当两个文件名称相同时,新文件不会导入

      4. 同名时保留两者:当两个文件名称相同时,新文件会导入,旧文件不会被删除

    3. 导入到分组:支持将文件导入到具体的分组中

      导入数据 - 图4

    4. 导入接口用例:开启开关后,已选择接口下的接口用例默认全选,也可以在 导入预览 中选择对应 接口用例

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

      当导入 Apifox 格式文件,且接口文档覆盖时,名称相同的 接口用例 会覆盖,不同名称的 接口用例 会新增。

    自动导入

    打开项目设置面板,点击自动导入,可设置多个数据源,定时同步到具体分组

    注意

    只有角色为管理员,且打开客户端的时候,才会按照设置的导入频率 自动导入

    其他角色不会触发自动导入

    导入数据 - 图6

    一、导入 OpenAPI (Swagger) 数据

    支持导入 OpenAPI 3Swagger 1、2、3数据格式的jsonyaml文件。

    注意

    需要URL导入的时候,需要填写的是jsonyaml数据文件的 URL,而不是Swagger UI的 URL。

    导入数据 - 图8

    支持 Postman Collection v2.1 格式。

    数据导出方法:找到 Postman 左侧列表 Collections,鼠标移到需要导出的集合,点击···,选择Export然后选择Collection v2.1 (recommended)即可导出,如下图所示:

    三、导入 ShowDoc 格式数据

    数据导出方法:点击 ShowDoc 文档右侧的展开按钮,找到导出按钮,点击后选择 markdown 压缩包 导出。

    导入数据 - 图10

    将从 ShowDoc 导出的 Markdown 压缩包 解压,会看到一个文件名为prefix_info.json的 json 文件。

    导入 Apifox 的时候,选择ShowDoc格式,然后导入前面解压得到的文件即可。

    支持Eolink 项目数据 (.json)格式。

    Eolink 数据导出方法:打开 Eolink 里对应项目,点击左侧菜单项目管理,展开后再点击项目设置,在右侧点击展开导出项目,展开后再点击导出项目按钮,选择Eolinker 项目数据 (.json),然后导出,如下图所示:

    Eolink 项目数据导出

    五、导入 ApiPost 数据

    支持 ApiPost Markdown 格式数据格式.

    数据导出方法:Apipost 版本 ≥5.4.2,打开 ApiPost,点击左侧导航项目,选择对应项目,点击右侧分享项目文档,在浏览器打开分享链接,在打开的网页里,找到右上角导出文档,选择导出MarkDown,然后导出,如下图所示:

    image-20210823172613701

    支持 DOCWAY 复制分享地址的方式导入数据。

    使用方法:打开 DOCWAY,进入对应项目,鼠标移到左上角更多功能点击分享项目(注意仅项目创建者有权限分享项目),创建分享 (注意“阅读密码”必须设置为空),然后复制分享地址将地址黏贴到下面输入框。如下图所示:

    DOCWAY 项目数据导出

    DOCWAY 项目数据导出

    七、导入 NEI 数据

    支持 NEI json 格式数据导入。

    NEI 导出数据方法:

    八、导入 apiDoc 数据

    支持 api_data.json 或 api_data.js 的文件,详情可以看

    导出方法:

    1. 本地安装 node 环境,使用 0.29.0 版本的 apidoc,进入源代码文件所在目录,运行 npx apidoc@0.29.0 -i src -o dist
    2. src 是接口的源代码文件,dist 是apidoc命令编译后生成的文件,dist 下面的 api_data.jsapi_data.json 就是导入 Apifox 用到的接口文件。

    导入数据 - 图22

    九、导入 Knife4j 数据

    支持 Knife4j 的 URL 直接导入,如图

    导入方法:

    1. 先输入 URL 进行

    image-20211012172829200