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

YAPI:从0搭建API文档管理工具,第1张

最近在找一款API文档管理工具,之前有用过Swagger、API Manager、Confluence,现在用的还是Confluence。

我个人一直不喜欢用Swagger,感觉“代码即文档”,让代码里的文档无处不在,已经对代码造成了一定的入侵了。API Manager就是一个纯API文档管理的工具了。Confluence是万明搏能的,也是最简单的,支持各种插件在线安装,可以有各种布局,支持MD文档,也支持表格、代码块等。

最近看到一篇文章在说YAPI,就准备搭建一个试试效果如何。

YAPI是去哪儿网开源的一款API管理工具,理念如下:

特性:

选择YAPI试试手的原因是因为我看到了它支持MockServer,这样前端开发同学就不用等待后端同学了。主要是我也懒得搭建一套mock服务,有这样一款工具何乐而不为呢?所以今天就找了一台服务器安装了一下。考虑排版问题,就以图片形式放出来了。

nodeJS长期支持版本官网下激薯祥载地址:https://nodejs.org/dist/v10.16.0/node-v10.16.0-linux-x64.tar.xz,下载后执行如下命令:

nodeJS安装完毕。

YAPI安装,GitHub上已经有比较详细的文档了,地址:https://github.com/YMFE/yapi,这里说一下两种部署方式:

可视化部署:

yapi安装完毕,访问http://127.0.0.1:9090进行可视化配置一步一步往下走即可。

命令行部署(推荐方式):

yapi安装完毕,访问http://127.0.0.1:{config.json中配置的port}即可访问。

node需要安装pm2模块,使用pm2模块后台运手数行yapi:

运行成功页面:

至此,YAPI就安装完毕了,简单实用一下还是不错的,因为是国产的,整体 *** 作风格还是比较习惯的。在YAPI这里接口更改还有记录哦~

后面再慢慢体验这个里面的一些高级功能吧,比如MockServer、接口测试等功能。

大家还有什么更好用的API管理工具?你觉得一款优秀的API管理工具应该都有哪些必须的功能?欢迎推荐和讨论!

nodejs 版本不要太高。太高会报错,亲测12.20.0可以

浏览器输入汪启 127.0.0.1:9090

等待一会就会提示我哗扰们部署完成

按照初始管理员账号,密码进入yapi就可以了

进入安装目录vendors/server 打开乱陵旦cmd输入以下命令,好了,我们的yapi服务已经启动,可以关掉cmd了,如果要开机启动,那么需要配置一下,具体的去看官网

pm2常见 *** 作


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/tougao/12502154.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-25
下一篇 2023-05-25

发表评论

登录后才能评论

评论列表(0条)

保存