YApi地址 #

yapi.mall3s.com

使用 #

从Swagger导入数据

使用管理员账号登录成功后，先创建一个mall-tiny-group分组；image.png

创建分组成功后，在该分组下点击创建项目，添加mall-tiny-swagger项目；

之后启动我们之前的mall-tiny-swagger项目，启动成功后Swagger接口文档访问地址：http://localhost:8088/swagger-ui/ (opens new window)

选择好YApi的数据管理功能，配置好Swagger的api-docs路径，然后进行数据导入；

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

接口管理

打开添加商品的接口看看，可以看到非常完善的接口文档信息，注释都有了；

来试试接口运行功能，我们会发现默认的接口请求地址并不符合我们的要求，需要在环境配置中设置；
由于是跨域请求，Chrome浏览器需要安装跨域请求插件，下载地址：https://github.com/YMFE/cross-request/archive/master.zip (opens new window)

由于我们的部分接口在请求头中添加token才能访问，所以我们先调用登录接口获取token；
之后在设置->环境配置中添加Authorization头；
再次调用需要登录的接口，可以正常获取到数据，返回数据虽然格式化了，但是没有折叠功能，数据太长的话就不太好看了；

Mock功能

在我们调用POST接口提交JSON数据时，默认Mock的JSON数据有点不太符合我们的要求；image.png
可以通过接口信息中的辑->高级设置进行修改；
我们可以发现每一个接口信息中都有个Mock地址，当我们后台接口已经定义好格式，但是没有实现时，前端可以使用该地址来Mock数据进行调试；
调用Mock地址可以获取到一些测试数据，数据取值返回可以通过上面的Mock设置自行修改；

从Swagger自动同步

当我们的接口修改了，API文档如何同步呢，我们可以通过设置->Swagger自动同步来开启自动同步功能，有三种数据同步模式可以选择；

权限管理

如果有新的成员加入进来，需要查看API文档怎么办？

首先可以通过注册界面注册一个成员账号，此处账号为test@qq.com:123456；
之后使用管理员账号登录，然后通过成员列表->添加成员，将用户添加到相应分组；
最后使用成员账号登录即可访问相应API文档了。

总结 #

YApi结合Swagger使用果然很强大！之前使用Postman结合Swagger使用时，文档查看、自动同步的问题都得到了解决，为了保证我们API文档访问的安全性还提供了权限管理功能。当API数据格式定义好后，Mock功能让前端无需后台实现也可以调试接口。不过对于JSON格式支持有点偏弱，要是能对JSON数据进行折叠显示就更好了！

转载说明 #

本文转载自《https://www.jianshu.com/p/b6bcf95ddbfe》

使用

总结

转载说明