一、导入 API 文档
性能入口:API 治理利用 / 选中某个我的项目 / API 文档菜单 / 点击“+ API”按钮旁的下拉按钮 / 选中“导入 API”
Eolink 提供一键导入已有 API 文档的性能,反对多种产品格局。罕用于新我的项目创立后,须要对旧我的项目或旧软件内数据进行迁徙的场景。
以后反对的产品格局如下:
1、按以上的性能入口门路进入导入 API 窗口。
2、抉择对应的导入数据类型格局。
3、配置导入规定
选项阐明
1)将 API 导入到以下分组:抉择对应的 API 分组
2)将新生成 API 文档状态设置为:能够将导入 API 文档设置对应状态
3)将产生变更的 API 文档状态设置为:如已产生变更状态的 API 文档,能够更新指定的文档状态
4)将新生成的或产生变更的 API 文档的版本号设置为:能够将导入 API 文档设置指定的 API 版本号
4、期待导入工作实现
设置好导入配置规定后 点击确定就会显示胜利提醒 并且右侧栏显示我的工作队列进行中 当状态显示实现就导入胜利了 如图
最初刷新页面就能够看到导入的 API 数据了 如图
二、导出文档
导出 API 文档
您能够将我的项目的 API 文档导出为多种离线格局,不便分享给团队以外的人。
导出形式分为 3 种:
- 导出我的项目内所有 API 文档
- 导出分组内的 API 文档
- 导出指定的 API 文档
导出我的项目内所有 API 文档
1、在左侧栏的项目管理中,抉择二级菜单我的项目设置,底部其余操作中点击“导出我的项目”。
导出我的项目反对以下格局:
- Eolink Apikit 我的项目数据
- Eolink Apikit API 相干数据
- HTML
- Word
- Excel
- Markdown
- Swagger JSON
- Swagger YAML
Eolink Apikit 我的项目数据 和 Eolink Apikit API 相干数据的差别在于,前者进去蕴含 API 相干数据外额定蕴含了状态码、我的项目文档、环境、数据结构等我的项目级公共数据,后者仅反对 API 文档、测试用例、高级 Mock 等数据。
2、第一选项 Eolink 我的项目数据(.json) 是将以后我的项目所有 API 数据进行导出 点击确定就能够进行导出操作 如图
3、其余格局会显示下一步按钮 点击下一步 跳转到抉择导出的内容
导出分组内的 API 文档
1、在左侧栏的 API 点击,抉择须要导入的分组,点击下拉框抉择导出 API
导出分组反对以下格局:
- Eolink Apikit
- Word
- Excel
- Markdown
留神:免费版产品仅反对导出 Eolink Apikit 格局,其余格局须要降级到专业版产品
2、点击下一步 跳转到抉择导出的内容 如图
导出指定的 API 文档
1、在左侧栏的 API 点击,抉择须要导入的分组或点击所有 API,点击右侧 API 列表标签页下的批量操作按钮 如图
2、选中须要导出的 API 数据,点击导出按钮 如图
导出指导 API 文档反对以下格局:
- Eolink Apikit
- Word
- Excel
- Markdown
留神:根底版产品仅反对导出 Eolink Apikit 格局,其余格局须要降级到专业版或企业版产品
3、点击下一步 跳转到抉择导出的内容
抉择导出的内容
1、如果是抉择导出我的项目内所有 API 文档形式 则左侧栏显示筛选 API 分组 右侧栏显示抉择筛选条件 如图
2、如果是抉择导出分组内 API 文档形式 则显示抉择筛选条件 如图
3、如果是导出指定的 API 文档,则显示筛选条件,并且只显示额定导出内容如图
筛选字段阐明
1)筛选 API 标签:能够筛选指定的 API 标签的数据
2)筛选 API 标记:能够筛选有星标和无星标的 API 数据
3)筛选 API 状态:能够筛选指定的 API 状态
4)额定导出内容:能够筛选 API 返回示例和 API 具体阐明等信息 (execl 和 Swagger 不反对该选项)
5)导出环境:能够导出指定的我的项目环境(Eolink 不反对改选项)
最初步骤
1、点击确定后 显示胜利提醒 并且右侧栏显示我的工作队列状态为进行中 胜利后就能够点击下载到本地了