一、引言:
YApi 是高效、易用、功能强大的API管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务
官网:https://yapi.ymfe.org/
因公司日常开发中需要管理接口,并测试,经对比后发现YAPI更合适。YAPI可以建立独立的项目空间,适配环境,mock参数。适用于前后端分离场景下的接口管理和测试。
API接口在设计时往往需要编写大量的文档,而且编写完成后往往需要根据实际情况经常改动文档,这使得文档编写维护工作量相对较大,让很多的开发者都很头疼。此外,伴随着接口版本的迭代开发,接口文档也需要同步更新。而且接口开发完成以后,做接口测试会十分不方便,要是遇上接口数量多、参数负载的情况,那不仅不方便,测试工作量会重上加重。
我们还经常会因为交付周期短且急的原因,需要接入一个第三方的库,而第三方的库通常都存在文档老旧,不够全面等等问题。这种等同没有文档的情况,对程序员来说相当棘手: 开发需要的接口不在文档上,文档上的接口不存在服务提供方的库里,又或者是少了一行关键的代码。这会使得接口开发的效率大幅下降,接口联调苦不堪言。
开发的苦恼
后端开发的苦恼
有了YAPI,我们可以很方便的测试、管理和维护多个项目的API接口,YAPI是一个独立的服务平台。
二、YAPI的环境搭建
系统环境:
CentOS 7.5
nodejs
mongodb
三、安装mongodb
创建mongodb仓库
1.创建mongo源文件
touch mongodb-org-3.4.repo
vim /etc/yum.repos.d/mongodb-org-3.4.repo
2.将下面的源地址复制到mongodb-org-3.4.repo
[mongodb-org-3.4]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/3.4/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-3.4.asc
3.安装mongodb,这里使用yum安装
yum install -y mongodb-org
4.安装完成后将bindIP改为0.0.0.0所有的机器都可以访问
vi /etc/mongod.conf
5.启动mongodb
systemctl start mongod.service //启动
systemctl stop mongod.service //停止
systemctl restart mongod.service //重启
6.设置mongodb开机自启动
systemctl enable mongod.service //开机自启动
7.测试mongodb
mongo 127.0.0.1:27017
四、安装nodejs
1.更新nodejs的yum源
curl --silent --location https://rpm.nodesource.com/setup_8.x | bash -
2.yum安装nodejs
yum install -y nodejs
3.安装完成后查看版本
node -v
五、安装YAPI
1.命令安装YAPI
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
2. yapi server安装后进入locahost:9090填写信息
部署完成后:
3. 启动YAPI
cd /root/my-yapi
#运行后台挂起命令,使得Yapi常驻后台
nohup node vendors/server/app.js 2>&1 &
4 .在浏览器中输入 部署的机器IP:3000
example: 127.0.0.1:3000
初始账号密码为:
admin@admin.com ymfe.org