rap2搭建教程

rap2是一个api可视化管理平台。

为啥需要API管理工具?

  • 对于后端:定义接口可视化定义,可以一键导出api文旦
  • 对于前端:面向数据接口编程,最主要的是提供mock数据功能,这样通过在封装的ajax请求中通过配置智能切换联调服务器和mock数据服务器(rap2搭建服务器)。当然为了切换省事,我们将可以启动不同的npm script脚本来切换。
  • 对于前后端分离:前后端分离完全按照定义的字段和数据格式,并且api服务器有日志功能,可以及时收到更改记录,这样避免了wiki化的接口文档在后端更改参数后没有及时通知前端导致联调过程中一些不必要的问题发生。前端完全可以根据与后端协商的数据格式去mock数据,这里的mock数据走的就是内网搭建的api服务器,这样等后端开发完接口部署到联调服务器上时,我们只需要将mock服务器的ip地址换成联调服务器地址,这样我们就可以做到完美切换联调服务器,毕竟其他请求参数和响应数据都是一样的,赞!

为啥选择rap2?

免费开源易部署,当然yapi也不错。

安装教程

准备一台内网服务器作为rap2服务器宿主机,以下搭建利用docker进行部署

  1. 安装docker
# 利用docker version 校验是否已经安装docker,如果没有安装利用以下命令进行安装
# 安装docker
curl -sSL https://get.daocloud.io/docker | sh
  1. 安装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
  1. 安装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 是否显示版本号
  1. 以上前置依赖准备好,就需要快速部署,
# 在任意地方建立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
  1. 第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

安装完后

愉快玩耍吧!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容