国内最全的Spring Boot系列之一》
国内最全的Spring Boot系列之二》
国内最全的Spring Boot系列之三》
国内最全的Spring Boot系列之四》
国内最全的Spring Boot系列之五》
你真的学会了Lambda表达式了吗?一篇让你学废了不香么 - 第417篇
当你的Stream遇上Lambda爱上了,超级无敌酷酷!- 第418篇
java8 lambda Stream api实战案例学彻底透彻 - 第419篇
Spring Boot使用ApplicationEvent实现事件发布的订阅功能(美女不能少,要通知) - 第420篇
悟纤:师傅,宝宝不开心。
师傅:徒儿,怎么了?阿姨来了?
悟纤:师傅,别闹~
师傅:徒儿怎么了?谁欺负你?
悟纤:最近和前端干了。
师傅:纳尼,怎么了?
悟纤:我把word的API修改后,前端拿着我旧的API文档在开发中,对方没有调试,就对我发脾气,我也很委屈。
师傅:徒儿别哭,师傅教你一招,网上API前端很难找到你的茬。
悟纤:师傅,对徒儿真好,师傅赶紧开始吧~
YApi坑太多了。我以为一个小时就能搞定。结果下午心态崩溃了。我太难了。这篇文章超级超级详细,强烈建议收藏,不然以后用的时候怕找不到。
API界面在设计中往往需要编写大量的文档,文档经常需要根据实际情况进行更改,这使得文档的编写和维护工作量相对较大,这让许多开发人员头疼。
此外,随着接口版本的迭代开发,接口文档也需要同步更新。此外,接口开发完成后,接口测试将非常不方便。如果接口数量大,参数负载大,不仅不方便,而且测试工作量也会增加。
为了提高接口管控效率,一个非常有用的接口管理平台-YAPI让我们一起来看看,YAPI多好啊。
对于上述问题,我们通常使用接口管理平台。
一方面,我们开发了一个接口管理平台(我公司开发了一个简单版本的接口管理平台),另一方面,我们在市场上找到了一个成熟的接口管理平台。
市场上有哪些接口管理平台? ?
Apifox:API 文档、API 调试、API Mock、API 自动化测试SaaS版本免费,私有化部署版本收费。
网址:https://www.apifox.cn
Swagger用于生成、描述、调用和可视化的规范和完整的框架 RESTful 风格的 Web 服务。
网址:https://swagger.io
YApi:YApi它是去哪网前端团队开源的接口管理工具,功能强大,自行部署方便。并且支持使用docker部署,使用成本很低。
网址:https://github.com/YMFE/yapi
体验地址:http://yapi.smart-xwork.cn/
文档:http://hellosean1025.github.io/yapi
Rap2:Rap2是阿里妈妈前端团队开源的接口管理工具。YApi至少上面的文档比较差,Github介绍不多,也没提到用docker但也是一种选择。
网址:https://github.com/thx/rap2-delos
eolinker:eolinker如果你不想部署自己的接口管理服务网站YApi、Rap2团队可以使用,免费版的功能对小团队来说就足够了。
网址:https://www.eolinker.com/
Postman:跨平台管理工具可免费使用和支持mock,支持团队合作,免费版本的限制主要是每月1000次,包括Mock请求、API要求等,对于小团队(3~5人)应该足够了。
网址:https://www.getpostman.com/
Apizza:极客独家界面协作管理工具,在线模拟调试,快速生成api文档,导出离线。
网址:https://www.apizza.net/
当然,除了上面的介绍,还有很多,适合自己是最好的~
对于Swagger前一篇文章有相关介绍,可以找到微信官方账号「SpringBoot」,回复关键字「swagger」或者「208」
YApi去哪儿网移动架构组(简称YMFE,一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开发的可视化接口管理工具,是一个可本地部署的、打通前后端及QA接口管理平台。
YApi旨在为开发、产品和测试人员提供更优雅的接口管理服务,帮助开发人员轻松创建、发布和维护不同的项目和平台API。有了YApi,我们可以方便地测试、管理和维护多个项目API接口,不像Swagger随应用生灭(而且大部分在线环境下都要关闭),YApi是一个独立的服务平台。
说了这么多,记住一个核心句子:
。
直接看官网介绍:
介绍了这么多,我们来看看。YApi如何安装使用?
Yapi需要nodejs(npm)和MongoDB,所以现在会演示如何安装。
下一步是macOS下可用,Linux下理,windows下没试过。
l nodejs(7.6+)
l mongodb(2.6+)
前往地址:https://nodejs.org/zh-cn/download/,下载安装包:
我这里macOS下载的是PKG的安装包,直接下一步下一步就安装好了,没啥好说的。
如果你有brew,那就直接执行:
brew install mongodb
如果没有的话,那么先把brew安装一下:
地址:https://brew.sh/
启动mongodb:
brew services start mongodb
YApi有两种部署方式:
(1)方式一. 可视化部署[推荐]
(2)方式二. 命令行部署
方式一是比较简单的方式,我们就使用方式一来看下如何部署。
执行 yapi server 启动可视化部署程序,输入相应的配置和点击开始部署,就能完成整个网站的部署。部署完成之后,可按照提示信息,执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱,默认密码(ymfe.org) 登录系统(默认密码可在个人中心修改)。
使用npm进行安装:
npm install -g yapi-cli --registry https://registry.npm.taobao.org
启动服务:
yapi server
在浏览器打开 http://127.0.0.1:9090 访问。
说明:
(1)网站地址是YApi的网站的地址,默认3000,没有特殊情况不用修改。
(2)数据库地址MongoDB的地址信息,默认也不用修改。
(3)部署路径,这个需要指定一下。
部署过程有点漫长,自己找点事干。
部署是真的很慢很慢很慢很慢呐,耗费了我30分钟,不知道干啥了~,还是说我的安装姿势不是很对❓
有可能是github仓库的原因吧,如果你安装成功的话,那么要恭喜你了。如果没有的话,那么使用第二种方式吧。
如果 github 压缩文件无法下载,或需要部署到一些特殊的服务器,可尝试此方法:
$ mkdir yapi
$ cd yapi
//或者下载 zip 包解压到 vendors 目录(clone 整个仓库大概 140+ M,可以通过 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令减少,大概 10+ M)
$ git clone https://github.com/YMFE/yapi.git vendors
//复制完成后请修改相关配置
$ cp vendors/config_example.json ./config.json
$ cd vendors
$ npm install --production --registry https://registry.npm.taobao.org
$ npm run install-server //安装程序会初始化数据库索引和管理员账号,管理员账号名可在 config.json 配置
$ node server/app.js //启动服务器后,请访问 127.0.0.1:{config.json配置的端口},初次运行会有个编译的过程,请耐心等候
服务已启动,请打开下面链接访问:
http://127.0.0.1:3000/
登录账号admin@admin.com,密码 ymfe.org
添加接口:
可能你上面的两种方式都安装失败了,没关系不要气馁。博主为你提供了第三种方式,这种方式大概率会成功的。安装的过程也挺简单的。
docker run -d --name mongo-yapi mongo
如果没有安装mongodb的话,不要慌,会自己pull最新版本的mogodb,多么贴心呐。
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
docker run -it --rm \
--link mongo-yapi:mongo \
--entrypoint npm \
--workdir /api/vendors \
registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
run install-server
自定义配置文件挂载到目录 /api/config.json
docker run -d \
--name yapi \
--link mongo-yapi:mongo \
--workdir /api/vendors \
-p 3000:3000 \
registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
server/app.js
访问http://localhost:3000
登录账号admin@admin.com,密码 ymfe.org
首先我们要创建一个项目。
当然你可以创建很多的项目。
我们的项目一般都是有很多的模块构成的,我们的接口也会进行分类,所以可以创建分类来管理接口:
此时我们就可以添加接口了:
删除接口需要一个oid的参数,点击【编辑】进行添加:
点击预览旁边的【运行】,在运行之前,先添加环境配置:
发送请求按钮此时是不可点击的,要安装一个插件。
选择手动下载,然后进行安装,这个浏览器的插件的安装就不过多说明了。
但可能你会采坑,这里提供采坑的方案:
(1)踩坑1:该扩展程序未列在 Chrome 网上应用店中,并可能是在您不知情的情况下添加的解决办法
https://zhuanlan.zhihu.com/p/106343392
(2)踩坑2:插件有问题,换个插件
https://www.jianshu.com/p/2417799e1a99
成功的效果图:
此时就可以点击运行了:
此时点击cross-request的【背景页】:
对应后端的代码比较简单,使用SpringBoot搭建的一个简单web项目:
YApi坑实在太多了,原本我以为1个小时就可以搞定的事情了,结果搞了我下午,心态都搞崩了,我太难了。强烈建议收藏起来,不然以后要用的时候,怕你找不到。
花了写的这么一篇大长文,点个赞👍,鼓励一下呗(*^▽^*)
我就是我,是颜色不一样的烟火。
我就是我,是与众不同的小苹果。
à悟空学院:https://t.cn/Rg3fKJD