2022-10-24-接口环境搭建yapi

yapi 环境搭建

前言

Yapi 是去哪儿网开源的一款接口管理工具。旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。以及自动化生成接口文档。

环境准备

操作系统：centos 7 环境要求：(若已有一下环境则可跳过)
nodejs>7.6
mongodb>2.6
git

1. 安装 nodejs （建议安装低版本 node 8.9.4）

1
yum install nodejs

建议安装 nvm
命令方式安装 nvm

1
2
3
4
5
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.2/install.sh | bash
或

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.2/install.sh | bash
其中版本v0.35.2可以在https://github.com/nvm-sh/nvm/releases中选择自己需要版本

安装完成后在~/.bashrc 等配置文件中会出现一下配置(如果没有请自己新增)

1
2
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

执行 source ~/.bashrc 使配置生效

使用 command -v nvm 验证是否安装成功

使用 nvm 安装 node，安装最新版本 node

1
2
nvm install node
nvm install v16.18.1

2. 安装 mangodb

安装 5.0 https://www.cnblogs.com/hahaha111122222/p/15868006.html
卸载 https://www.yisu.com/ask/7617.html

  • 1、更新 yum 源，非必须但是更新一下无害
1
yum -y update
  • 2、添加 mongodb 源文件，在/etc/yum.repos.d 创建一个 mongodb-org.repo 文件
1
touch /etc/yum.repos.d/mongodb-org.repo
  • 3、编辑 mongodb-org.repo 文件
1
vim /etc/yum.repos.d/mongodb-org.repo
  • 4、添加文件内容
1
2
3
4
5
[mongodb-org]
name=MongoDB Repository
baseurl=http://mirrors.aliyun.com/mongodb/yum/redhat/7Server/mongodb-org/6.0/x86_64/
gpgcheck=0
enabled=1
  • 5、安装 mongodb
1
yum install -y mongodb-org
  • 6、启动 mongodb
1
service mongod start
  • 7、设置开机启动
1
chkconfig mongod on
  • 8、打开 moMongoDB（可忽略）
1
/bin/mongo
  • 9、配置远程访问，修改 mongod.conf 配置文件
1
2
3
4
5
vim /etc/mongod.conf

将 bindIp: 127.0.0.1  改为 bindIp: 0.0.0.0

重启mongod执行 ：service mongod restart

3. 安装 git

官方推荐，在内网部署的时候安装 git，可以根据自己所需安装

1
yum -y install git

4. 搭建 yapi 环境

  • 1、准备环境搭建完成后，开始搭建 Yapi，安装命令
1
2
3
cd /usr/local
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

安装yapi

  • 2、执行 yapi server 启动可视化部署程序，浏览器打开提示窗口上的地址 9090 端口，非本地服务器，将 0.0.0.0 替换指定的域名或 IP，进入部署页面。
    启动yapi部署配置
  • 3、根据项目实际需要可以修改部署信息，点击【开始部署】，完成部署任务，部署成功截图
    可能会出错，报错信息如下：
    部署报错提示
  • 原因：yapi.demo.qunar.com 这个域名服务器挂了
  • 修改方式：选择新部署版本重新部署，默认 1.4.1 改为 1.10.2 即可
  • 4、根据部署日志截图上的提示信息
    启动服务
1
2
3
4
cd usr/local/my-yapi # 进入到自己的 yapi 里的当前目录
node vendors/server/app.js

账号"827516789@qq.com"，密码："ymfe.org"

启动服务（以守护进程启动）

1
node vendors/server/app.js &

浏览器打开部署日志上的访问地址http://127.0.0.1:3000就可以访问搭建的YApi工具了（非本地服务器，将127.0.0.1替换指定的域名或IP），此时YApi环境搭建完。

  • 5、pm2 方式管理进程（避免终端断开，杀死进程）

要保证后台保持进程，需要安装 pm2。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
全局安装：
npm install -g pm2

启动：
cd /usr/local/my-yapi/vendors
pm2 start server/app.js --watch

重启：

pm2 restart server/app.js

停止：

可以先通过pm2 list获取应用的名字（--name指定的）或者进程id。

pm2 stop app_name|app_id

pm2 使用参考文档：
http://imweb.io/topic/57c8cbb27f226f687b365636

6.升级

升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。

1
2
3
4
cd  {项目目录}
yapi ls //查看版本号列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本

9.nginx 代理

如果您是将服务器代理到 nginx 服务器，请配置 nginx 支持 websocket。

1
2
3
4
在location /添加
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

10.禁止注册

在 config.json 添加 closeRegister:true 配置项,就可以禁止用户注册 yapi 平台，修改完成后，请重启 yapi 服务器。

1
2
3
4
{
  "port": "*****",
  "closeRegister":true
}

gitlab 私服搭建

前端工程化
#yapi
2022-10-24-接口环境搭建yapi
https://zhangyingxuan.github.io/2022-10-24-【工程化】接口环境搭建yapi/
作者
blowsysun
许可协议