简介:
YApi简介
YApi是高效、易用、功能强大的API管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。YApi在Github上已累计获得了18K+Star,具有优秀的交互体验,YApi不仅提供了常用的接口管理功能,还提供了权限管理、Mock数据、Swagger数据导入等功能,总之功能很强大!安装环境准备
本地部署YApi需要先安装nodejs和MongoDB,我们先把它们安装好。
YApi简介
YApi是高效、易用、功能强大的API管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。YApi在Github上已累计获得了18K+Star,具有优秀的交互体验,YApi不仅提供了常用的接口管理功能,还提供了权限管理、Mock数据、Swagger数据导入等功能,总之功能很强大!
安装
环境准备
本地部署YApi需要先安装nodejs和MongoDB,我们先把它们安装好。
安装yapi-cli
yapi-cli
是YApi官方提供的安装工具,可以通过可视化界面来部署YApi服务,非常方便!
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
安装YApi
node vendors/server/app.js
使用
从Swagger导入数据
接口管理
Mock功能
从Swagger自动同步
权限管理
如果有新的成员加入进来,需要查看API文档怎么办?
总结
YApi结合Swagger使用果然很强大!之前使用Postman结合Swagger使用时,文档查看、自动同步的问题都得到了解决,为了保证我们API文档访问的安全性还提供了权限管理功能。当API数据格式定义好后,Mock功能让前端无需后台实现也可以调试接口。不过对于JSON格式支持有点偏弱,要是能对JSON数据进行折叠显示就更好了!
参考资料
官方文档:https://hellosean1025.github.io/yapi/documents/index.html
项目源码地址
https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-swagger
原文地址