YAPI:从0搭建API文档管理工具


YAPI:从0搭建API文档管理工具

文章插图
 
背景最近在找一款API文档管理工具,之前有用过Swagger、API Manager、Confluence,现在用的还是Confluence 。
我个人一直不喜欢用Swagger,感觉“代码即文档”,让代码里的文档无处不在,已经对代码造成了一定的入侵了 。API Manager就是一个纯API文档管理的工具了 。Confluence是万能的,也是最简单的,支持各种插件在线安装,可以有各种布局,支持MD文档,也支持表格、代码块等 。
最近看到一篇文章在说YAPI,就准备搭建一个试试效果如何 。
YAPI简介YAPI是去哪儿网开源的一款API管理工具,理念如下:
YApi让接口开发更简单高效,让接口的管理更具可读性、可维护性,让团队协作更合理 。
特性:
基于 Json5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍
扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性
类似 postman 的接口调试
自动化测试, 支持对 Response 断言
MockServer 除支持普通的随机 mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据
支持 postman, har, swagger 数据导入
免费开源,内网部署,信息再也不怕泄露了
选择YAPI试试手的原因是因为我看到了它支持MockServer,这样前端开发同学就不用等待后端同学了 。主要是我也懒得搭建一套mock服务,有这样一款工具何乐而不为呢?所以今天就找了一台服务器安装了一下 。考虑排版问题,就以图片形式放出来了 。
依赖环境
  • 系统版本:linux centos 7.4
  • nodeJS
  • MongoDB
  • Git
安装步骤nodeJs安装nodeJS长期支持版本官网下载地址:https://nodejs.org/dist/v10.16.0/node-v10.16.0-linux-x64.tar.xz,下载后执行如下命令:
YAPI:从0搭建API文档管理工具

文章插图
nodeJS安装命令
nodeJS安装完毕 。
MongoDB安装
YAPI:从0搭建API文档管理工具

文章插图
MongoDB安装命令
Git安装#yum安装,这个最简单了yum -y install gitYAPI安装YAPI安装,GitHub上已经有比较详细的文档了,地址:https://github.com/YMFE/yapi,这里说一下两种部署方式:
可视化部署:
YAPI:从0搭建API文档管理工具

文章插图
YAPI可视化部署
yapi安装完毕,访问http://127.0.0.1:9090进行可视化配置一步一步往下走即可 。
命令行部署(推荐方式):
YAPI:从0搭建API文档管理工具

文章插图
命令行部署(推荐)
【YAPI:从0搭建API文档管理工具】yapi安装完毕,访问http://127.0.0.1:{config.json中配置的port}即可访问 。
后台运行YAPInode需要安装pm2模块,使用pm2模块后台运行yapi:
YAPI:从0搭建API文档管理工具

文章插图
pm2运行yapi
运行成功页面:
YAPI:从0搭建API文档管理工具

文章插图
yapi运行成功页面
至此,YAPI就安装完毕了,简单实用一下还是不错的,因为是国产的,整体操作风格还是比较习惯的 。在YAPI这里接口更改还有记录哦~
YAPI:从0搭建API文档管理工具

文章插图
YAPI控制台
后面再慢慢体验这个里面的一些高级功能吧,比如MockServer、接口测试等功能 。
大家还有什么更好用的API管理工具?你觉得一款优秀的API管理工具应该都有哪些必须的功能?欢迎推荐和讨论!




    推荐阅读