为什么不选择 Swagger

这几天跟我同事聊了一下,他是个老后端开发了,他回忆起以前他们都是用 Swagger 这款 API 工具来管理 API 的。

然后我就问他,那为啥现在不用了呢?为啥要选择其他呢?

他列举了一些 Swagger 的缺点:

  • 界面看起来不好看
  • 数据无法进行格式化
  • 数据结构无法折叠,看起来麻烦
  • 参数问题定位起来难受

用新工具?旧数据咋办

同事说,这就涉及到 接口项目迁移 了,其实以前的人早就想到这点了,所以有比较方便快捷的办法 —— 导入导出,有了这个功能,大大降低了项目迁移时的成本

导出 Swagger 数据

操作

那要怎么导出 Swagger 的数据呢?其实很简单,Swagger 自带了导出功能,能导出一个项目的 JSON 格式文件~

最佳实践:YApi 导入 Swagger 数据:_程序员

结果

导出的文件,具体长这样,是一个 JSON 格式的文件,且里面是各个接口的映射:

最佳实践:YApi 导入 Swagger 数据:_yapi_02

不用 Swagger 用啥?

不用 Swagger 了,那用啥,现在很多开发都使用 YApi、Apifox。

YApi

是啥

YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。本文将带领大家搭建 YApi 接口平台。

导入 Swagger

刚刚我们已经导出了 Swagger 的 JSON 文件了,我们现在需要把这个文件导入到 YApi 中,这样才能实现项目迁移

我们需要进入 YApi 的导入界面,选择目标文件,以及覆盖模式。

最佳实践:YApi 导入 Swagger 数据:_yapi_03

最佳实践:YApi 导入 Swagger 数据:_接口文档_04

然后把刚刚的 JSON 文件拖拽进去即可,成功了会提示。

最佳实践:YApi 导入 Swagger 数据:_API_05

Apifox 导入 Swagger

你也可以使用 Apifox 进行项目迁移,然后使用它进行 API 管理。

操作

需要进入 项目设置,然后选择需要导入的格式,Apifox 支持 20 多种导入格式,是 YApi 的好几倍!

最佳实践:YApi 导入 Swagger 数据:_接口文档_06

导入

把 JSON 文件拖进去后,Apifox 会进行解析,并弹出窗口,让你选择你所需要导入的接口!!!这点就做的比 YApi 好,因为 YApi 没有这个功能,它只能导入所有~

最佳实践:YApi 导入 Swagger 数据:_swagger_07

结果

点击 确认导入,等待导入成功后,会弹出结果弹窗

最佳实践:YApi 导入 Swagger 数据:_yapi_08

并且在 接口列表 里看到导入的接口

最佳实践:YApi 导入 Swagger 数据:_程序员_09

知识扩展: