跳到主要内容

导出接口

Apifox 支持以 OpenAPI (原 Swagger)、HTML、Markdown、Apifox 等数据格式导出接口。

导出数据​

打开“项目设置”面板，点击左侧菜单栏中的“导出数据”选项，选择需要导出的数据格式，点击“导出”按钮即可。

导出数据

支持导出全部接口或手动圈选接口。

导出数据

你也可以根据标签、状态和责任人来筛选接口并导出。

导出数据

其中 OpenAPI (Swagger) 支持导出 3.1、3.0和2.0 版本以及 RAW 格式链接。

导出数据

点击“打开 URL”按钮即可在浏览器中查看 RAW 格式内容。

导出数据

在迭代分支中导出数据​

支持导出迭代分支数据，页面左上角显示的分支即为导出的目标分支。如果选择导出迭代分支，则必须要导出迭代分支的全量数据。


导出迭代分支的具体逻辑为：导出包含当前迭代分支与主分支合并后的内容。这样做的原因是为了保证导出的数据完整性。Apifox 中非常多的数据是通过“引用”的方式构建的，如果是像 Apifox 内一样导出迭代分支时仅展示看到的部分内容，很有可能导致导出数据完全不可用。

导出迭代分支数据

迭代分支导出不可选择导出内容范围，只能导出包含当前迭代分支与主分支合并后的全部内容。

OperationID​

OperationId 是 OpenAPI 规范中用于唯一标识 API 操作（Operation）的字符串。支持设置 OperationId 属性，导出 OpenAPI 格式时会将此处的值导出到 Operation 对象的 OperationId 里。


要设置 OperationId，请先到“项目设置”中开启该功能。

OperationID 设置

然后在“修改文档”页中即可编辑。

OperationID 编辑

常见问题​

1. 导出 Markdown、HTML 格式时接口顺序为什么乱了？​

  1. Swagger 规范里是没有顺序的概念的，也没有分组的概念，所以导出 Swagger 格式是错乱的。
  2. 若需要严格规范顺序，建议选择以 Apifox 格式导出。

2. 为什么导出的接口数量变少了？​

  1. 这有可能是因为 API 文档存在多个使用了相同方法或路径的接口，OpenAPI 规范不支持不同接口使用相同方法和路径，请查看《接口唯一标识》。
  2. 导出 HTML、Markdown 格式时，Apifox 先将 API 文档转化成 OpenAPI 文档，然后再进行转译得到这两种格式的文件，有可能出现相同的问题。

3. 如何导出 PDF 格式文件？​

目前不支持直接导出 PDF、Word 等其他格式数据，但你可以先导出 Markdown 数据格式，然后再使用外部工具或者编写脚本将 Markdown 转换为其它需要的格式，具体可参考这篇文章《如何将 Markdown 转为其它格式》。


4. 如何导出 Auth 值？​

无需额外设置，Apifox 已支持导出 OpenAPI (原 Swagger) 格式文件时一并附带 Auth 中的值。你可以在 Swagger 格式文件中输入 securitySchemes 进行检索。