【docker系列】docker安装yapi

前言

YApi是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台，使用起来还是很方便的，简单讲一下docker安装YApi

一、docker安装

地址：https://gitee.com/fjc0k/docker-YApi

1、拉取镜像

docker pull jayfong/yapi:play

2、定义环境变量文件

vim yai-play-env.cof

YAPI_ADMIN_ACCOUNT=[e-mail]

YAPI_ADMIN_PASSWORD=123456

YAPI_CLOSE_REGISTER=true

YAPI_MAIL_ENABLE=false

YAPI_LDAP_LOGIN_ENABLE=false

YAPI_PLUGINS=[]

3、启动容器

docker run -p 3000:3000 -p 27017:27017  -v /data/mongodb:/data/db --env-file /usr/local/software/yapi/yapi-play-env.conf --name yapi-play -d jayfong/yapi:play

二、在线安装

2.1、 可视化部署[推荐]

执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。

1、安装yapi-cli

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

2、建立软连接

ln -s /usr/local/software/node/node-v12.19.0-linux-x64/bin/yapi /usr/bin/yapi

ln -s /usr/local/software/node/node-v12.19.0-linux-x64/bin/ykit /usr/bin/ykit

3、启动可视化安装

yapi server

4、打开浏览器访问ip:9090

然后按照步骤即可完成安装

5、启动

创建启动脚本startup.sh

#!/bin/bash

nohup node vendors/server/app.js >/dev/null 2>&1 &

sh startup.sh 启动

浏览器访问ip:3000

2.2、命令行部署

如果 github 压缩文件无法下载，或需要部署到一些特殊的服务器，可尝试此方法

mkdir yapi

cd yapi

git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录（clone 整个仓库大概 140+ M，可以通过 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令减少，大概 10+ M）

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配置的端口}，初次运行会有个编译的过程，请耐心等候