DingMing

丁大铭的个人空间,用来分享一些前端小技巧,默默成长吧,哈哈

当Swagger遇上YApi,瞬间高大上了!

  |  
 阅读次数

1.YApi简介

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

2.背景

我们公司的后端api接口文档一直使用的是Swagger进行开发的,Swagger开发对后端同学十分友好,方便生成。但是对于前端同学mock数据,同步开发存在着很大的困扰。

研究发现在我们的YApi上可以实时的同步Swagger数据,这样对于前后端同学开发都十分的方便。接下来我来分享下操作步骤

3.YApi创建并进入项目配置

  • 创建项目
  • 进入配置页面
  • 这里可以选择完全覆盖
  • 如何获取swagger json
  • 为了统一swagger环境,我们这里需要统一使用featrue环境的json数据
  • 10分钟同步拉取一次swagger数据
  • 同步效果

4.总结

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