rap2搭建教程
2020-04-19 本文已影响0人
peakol
rap2是一个api可视化管理平台。
为啥需要API管理工具？
- 对于后端：定义接口可视化定义，可以一键导出api文旦
- 对于前端：面向数据接口编程，最主要的是提供mock数据功能，这样通过在封装的ajax请求中通过配置智能切换联调服务器和mock数据服务器（rap2搭建服务器）。当然为了切换省事，我们将可以启动不同的npm script脚本来切换。
- 对于前后端分离：前后端分离完全按照定义的字段和数据格式，并且api服务器有日志功能，可以及时收到更改记录，这样避免了wiki化的接口文档在后端更改参数后没有及时通知前端导致联调过程中一些不必要的问题发生。前端完全可以根据与后端协商的数据格式去mock数据，这里的mock数据走的就是内网搭建的api服务器，这样等后端开发完接口部署到联调服务器上时，我们只需要将mock服务器的ip地址换成联调服务器地址，这样我们就可以做到完美切换联调服务器，毕竟其他请求参数和响应数据都是一样的，赞！
为啥选择rap2？
免费开源易部署，当然yapi也不错。
安装教程
准备一台内网服务器作为rap2服务器宿主机，以下搭建利用docker进行部署
- 安装docker
# 利用docker version 校验是否已经安装docker，如果没有安装利用以下命令进行安装
# 安装docker
curl -sSL https://get.daocloud.io/docker | sh
- 安装Docker Compose（docker compose其实类似于package.json）
# 安装docker compose
curl -L https://get.daocloud.io/docker/compose/releases/download/1.25.5/docker-compose-`uname -s`-`uname -m`
/usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
- 安装node
# 通过wget下载安装包,（当然也可以在本地下载好node包，然后通过ftp传到服务器）
wget https://nodejs.org/dist/v10.16.0/node-v10.16.0-linux-x64.tar.xz
# 解压安装包
tar xf node-v10.16.0-linux-x64.tar.xz
# 进入node bin目录（bin目录是存放的命令目录）
cd node-v10.16.0-linux-x64/bin
# 设置环境变量（环境变量的作用就是在任何路径都能映射命令）
vim /etc/profile
export PATH=$PATH:/root/node-v10.16.0-linux-x64/bin
# 配置生效
source /etc/profile
# 此时可以验证下node -v 是否显示版本号
- 以上前置依赖准备好，就需要快速部署，
# 在任意地方建立rap文件夹(我建在了hll)
cd /hll && mkdir rap
# 把下面的docker-compose.yml放到rap目录下，一些配置文件可以根据自
己需求变更，默认开放了mysql容器的端口映射到宿主机的33306端口上
# 拉取镜像并启动
docker-compose up -d
# 启动后，第一次运行需要手动初始化mysql数据库
# 注意: 只有第一次该这样做
docker-compose exec delos node scripts/init
# 部署成功后 访问
http://{宿主机IP}:3008 # 前端（可自定义端口号）
http://{宿主机IP}:38080 # 后端
# 如果访问不了可能是数据库没有链接上，关闭 rap 服务
docker-compose down
# 再重新运行
docker-compose up -d
# 如果 Sequelize 报错可能是数据库表发生了变化，运行下面命令同步
docker-compose exec delos node scripts/updateSchema
- 第4步已经完成了rap2服务器的搭建，如果需要升级项目，或者更改配置（主要是docker-compose.yml）时
# 需要先暂停服务
docker-compose down
# 更新时拉取新镜像
docker-compose pull
# 如果需要更改配置可以通过vim docker-compose.yml,这部和更新可以二选一，也可以既更新又更改
vim docker-compose.yml
:wq
# 重新构建并启动
docker-compose up -d --build
# 有时表结构会发生变化，执行下面命令同步
docker-compose exec delos node scripts/updateSchema
# 清空不被使用的虚悬镜像
docker image prune -f
安装完后
愉快玩耍吧！
