网站首页 > 博客文章 正文
背景
最近在找一款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,下载后执行如下命令:
nodeJS安装完毕。
MongoDB安装
Git安装
#yum安装,这个最简单了 yum -y install git
YAPI安装
YAPI安装,GitHub上已经有比较详细的文档了,地址:https://github.com/YMFE/yapi,这里说一下两种部署方式:
可视化部署:
yapi安装完毕,访问http://127.0.0.1:9090进行可视化配置一步一步往下走即可。
命令行部署(推荐方式):
yapi安装完毕,访问http://127.0.0.1:{config.json中配置的port}即可访问。
后台运行YAPI
node需要安装pm2模块,使用pm2模块后台运行yapi:
运行成功页面:
至此,YAPI就安装完毕了,简单实用一下还是不错的,因为是国产的,整体操作风格还是比较习惯的。在YAPI这里接口更改还有记录哦~
后面再慢慢体验这个里面的一些高级功能吧,比如MockServer、接口测试等功能。
大家还有什么更好用的API管理工具?你觉得一款优秀的API管理工具应该都有哪些必须的功能?欢迎推荐和讨论!
猜你喜欢
- 2024-10-05 API 文档简洁之美,只需三步开启(api文档怎么写)
- 2024-10-05 自动接口文档生成实战教程(接口自动化上传文件)
- 2024-10-05 Postman与APIfox:两款强大的接口测试工具详解
- 2024-10-05 在线API文档工具Knife4j简明使用教程
- 2024-10-05 推荐四个强大的API管理平台(推荐四个强大的api管理平台是)
- 2024-10-05 接口文档生成详细教程(接口文档自动生成工具)
- 2024-10-05 TP5接口文档管理(tp5接口开发)
- 2024-10-05 推荐几款常见的API接口管理工具(api接口使用教程)
- 2024-10-05 一款零注解侵入的 API 文档生成工具,你用过吗?
- 2024-10-05 接口测试工具(接口测试工具swagger)
你 发表评论:
欢迎- 最近发表
- 标签列表
-
- ifneq (61)
- 字符串长度在线 (61)
- googlecloud (64)
- messagesource (56)
- promise.race (63)
- 2019cad序列号和密钥激活码 (62)
- window.performance (66)
- qt删除文件夹 (72)
- mysqlcaching_sha2_password (64)
- ubuntu升级gcc (58)
- nacos启动失败 (64)
- ssh-add (70)
- jwt漏洞 (58)
- macos14下载 (58)
- yarnnode (62)
- abstractqueuedsynchronizer (64)
- source~/.bashrc没有那个文件或目录 (65)
- springboot整合activiti工作流 (70)
- jmeter插件下载 (61)
- 抓包分析 (60)
- idea创建mavenweb项目 (65)
- vue回到顶部 (57)
- qcombobox样式表 (68)
- tomcatundertow (58)
- pastemac (61)
本文暂时没有评论,来添加一个吧(●'◡'●)