关于java:当Swagger遇上YApi瞬间高大上了

Swagger 常常被人吐槽界面不够难看、性能不够弱小，其实有很多工具能够和 Swagger 联合应用，联合之后就会变得十分好用。之前写过一篇文章《Swagger 界面丑、性能弱怎么破？用 Postman 加强下就给力了！》，有敌人留言说 YApi 也很好用。最近体验了一把 YApi，发现的确不错，举荐给大家！

SpringBoot 实战电商我的项目 mall（40k+star）地址：https://github.com/macrozheng/mall

YApi 简介

YApi 是高效、易用、功能强大的 API 治理平台，旨在为开发、产品、测试人员提供更优雅的接口治理服务。YApi 在 Github 上已累计取得了 18K+Star，具备优良的交互体验，YApi 不仅提供了罕用的接口治理性能，还提供了权限治理、Mock 数据、Swagger 数据导入等性能，总之性能很弱小！

装置

环境筹备

本地部署 YApi 须要先装置 nodejs 和 MongoDB，咱们先把它们装置好。

• 装置 nodejs，间接下载安装包双击装置即可，这里装置的是 12.14.0 版本，下载地址：https://nodejs.org/dist/v12.1…;
• 装置 MongoDB，参考《MongoDB 疾速入门，把握这些刚刚好！》中的装置即可，这里装置的是 4.2.5 版本。

装置 yapi-cli

yapi-cli是 YApi 官网提供的装置工具，能够通过可视化界面来部署 YApi 服务，十分不便！

• 应用 npm 命令来装置yapi-cli：

npm install -g yapi-cli --registry https://registry.npm.taobao.org

• 装置胜利后控制台输入如下内容；

• 装置胜利后应用 yapi server 命令来启动 YApi 的可视化部署界面。

yapi server

装置 YApi

• 通过可视化部署界面装置 YApi 服务，拜访地址：http://localhost:9090

• 装置实现后会输入如下信息，提醒 YApi 的默认管理员账号密码及拜访地址；

• 进入 YApi 的装置目录，应用 node 命令启动 YApi 服务：

node vendors/server/app.js

• 启动胜利后控制台输入信息如下；

• 通过页面拜访 Yapi，默认账号密码为admin@admin.com:ymfe.org，拜访地址：http://localhost:3000

应用

从 Swagger 导入数据

• 应用管理员账号登录胜利后，先创立一个 mall-tiny-group 分组；

• 创立分组胜利后，在该分组下点击 创立我的项目 ，增加mall-tiny-swagger 我的项目；

• 之后启动咱们之前的 mall-tiny-swagger 我的项目，启动胜利后 Swagger 接口文档拜访地址：http://localhost:8088/swagger-ui/

• 抉择好 YApi 的 数据管理 性能，配置好 Swagger 的 api-docs 门路，而后进行数据导入；

• 至此 Swagger 中的 API 接口已胜利导入到 YApi，点击 接口 标签查看所有导入接口。

接口治理

• 关上 增加商品 的接口看看，能够看到十分欠缺的接口文档信息，正文都有了；

• 来试试接口运行性能，咱们会发现默认的接口申请地址并不合乎咱们的要求，须要在 环境配置 中设置；

• 因为是跨域申请，Chrome 浏览器须要装置跨域申请插件，下载地址：https://github.com/YMFE/cross…

• 因为咱们的局部接口在申请头中增加 token 能力拜访，所以咱们先调用登录接口获取 token；

• 之后在 设置 -> 环境配置 中增加 Authorization 头；

• 再次调用须要登录的接口，能够失常获取到数据，返回数据尽管格式化了，然而没有折叠性能，数据太长的话就不太好看了；

Mock 性能

• 在咱们调用 POST 接口提交 JSON 数据时，默认 Mock 的 JSON 数据有点不太合乎咱们的要求；

• 能够通过接口信息中的 编辑 -> 高级设置 进行批改；

• 咱们能够发现每一个接口信息中都有个 Mock 地址，当咱们后盾接口曾经定义好格局，然而没有实现时，前端能够应用该地址来 Mock 数据进行调试；

• 调用 Mock 地址能够获取到一些测试数据，数据取值返回能够通过下面的 Mock 设置自行批改；

从 Swagger 主动同步

• 当咱们的接口批改了，API 文档如何同步呢，咱们能够通过 设置 ->Swagger 主动同步 来开启主动同步性能，有三种数据同步模式能够抉择；

权限治理

如果有新的成员退出进来，须要查看 API 文档怎么办？

• 首先能够通过注册界面注册一个成员账号，此处账号为test@qq.com:123456；

• 之后应用管理员账号登录，而后通过 成员列表 -> 增加成员，将用户增加到相应分组；

• 最初应用成员账号登录即可拜访相应 API 文档了。

总结

YApi 联合 Swagger 应用果然很弱小！之前应用 Postman 联合 Swagger 应用时，文档查看、主动同步的问题都失去了解决，为了保障咱们 API 文档拜访的安全性还提供了权限治理性能。当 API 数据格式定义好后，Mock 性能让前端无需后盾实现也能够调试接口。不过对于 JSON 格局反对有点偏弱，要是能对 JSON 数据进行折叠显示就更好了！

参考资料

官网文档：https://hellosean1025.github….

我的项目源码地址

https://github.com/macrozheng…

本文 GitHub https://github.com/macrozheng/mall-learning 曾经收录，欢送大家 Star！