YApi 搭建属于团队的接口管理平台

1,102 阅读2分钟

这是我参与更文挑战的第2天,活动详情查看: 更文挑战

前言

传统的方式当后端开发完接口,然后通过文档的形式通知前端去对接接口,而接口有修改或更新,就需要重新以文档的形式覆盖之前那份,这样反反复复不利于更新和维护,这时我们需要一个接口管理后台,通过后台来规范接口文档,而且还利于改动的追溯,以下我使用 YApi 来搭建属于自己接口团队的接口管理后台,因为 YApi 功能强大,可以实现内网部署,高效而且易用。

一、环境要求

  • linux 系统
  • node.js(7.6+)
  • mongodb(2.6+)
  • pm2

二、node.js 安装

YApi 依赖 Node v7.6.0 及以上版本,如果 Node 版本低于 7.6.0,请 升级 Node 版本,如果手上的项目需要依赖不同版本的 Node.js 环境可以通过 Node.js 版本管理工具 nvm 来切换当前项目所需要的版本。

// 选择 Node.js 的安装版本
$ curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - 

// 安装node.js
$ yum install -y nodejs

三、mongodb 安装

(1)配置 mongodb 的 yum 源文件

配置源文件目的是从定义好的路径中查找依赖软件并且安装好。

//  cd /etc/yum.repos.d 创建一个 mongodb-org.repo 文件
$ touch /etc/yum.repos.d/mongodb-org.repo

(2)编辑 mongodb-org.repo 文件

$ vim /etc/yum.repos.d/mongodb-org.repo

(3)给 mongodb-org.repo 文件 添加如下内容

[mongodb-org]
name=MongoDB Repository
baseurl=http://mirrors.aliyun.com/mongodb/yum/redhat/7Server/mongodb-org/4.4/x86_64/
gpgcheck=0
enabled=1

(4)安装 mongodb

$ yum install -y mongodb-org

(5)启动 mongodb

$ service mongod start 或 systemctl start mongod.service

(6)查看启动状态,是否启动成功

$ service mongod status 或 systemctl status mongod.service

四、配置 YApi

(1)YApi 安装并启动

这里我使用了部署的推荐的方式,执行 yapi server 启动可视化部署程序。在浏览器访问 http://0.0.0.0:9000,将 0.0.0.0 替换成你服务器上的域名或 IP 即可。

$ npm install -g yapi-cli --registry https://registry.npm.taobao.org
$ yapi server

yapi.png

(2)平台部署

出现以下页面就是可视化部署的方式,输入相应的配置和点击开始部署,就能完成整个网站的部署。

111.png

(3)启动服务

部署完成之后,可按照提示信息,执行 node /verdors/server/app.js 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱,默认密码(ymfe.org) 登录系统(默认密码可在个人中心修改)。

启动.png

// 启动服务
$ node /verdors/server/app.js 

五、使用 pm2 守护服务进程

YApi 启动服务后,如果退出命令终端或者操作 "ctrl+c" 命令会使YApi的进程会立即终止,YApi的服务就没法访问了,这时候我们需要守护这个进程,我们可以是 pm2 或者 forever 等来守护进程,下面我使用了pm2来处理。

// 安装 pm2
$ npm install pm2 -g

// cd /verdors/server/
$ pm2 start app.js

六、使用

在浏览器访问 http://0.0.0.0:3000,将 0.0.0.0 替换成你服务器上的域名或IP就可以使用了,这是 官方使用文档,里面强大的功能,等待你去发掘。

1111.png