阿里妈妈前端团队出品的开源的接口管理工具-RAP第二代 http://rap2.taobao.org
(后端 API 服务器)
RAP2 是在 RAP1 基础上重做的新项目,它能给你提供方便的接口文档管理、Mock、导出等功能,包含两个组件(对应两个 Github Repository)。
Rap 官方服务站点,无需安装直接体验: rap2.taobao.org
注意:本工具为开发工具,相关API未做任何XSS等安全验证,请勿在生产环境依赖RAP的任何服务!!!
有急事来官方钉钉群,响应更迅速: 11789704
手动部署
环境要求
- Node.js 8.9.4+
- MySQL 5.7+
- Redis 4.0+
- pandoc 2.73 (供文档生成使用)
开发模式
安装 MySQL 和 Redis 服务器
请自行查找搭建方法,mysql/redis 配置在 config.*.ts 文件中,在不修改任何配置的情况下, redis 会通过默认端口 + 本机即可正常访问,确保 redis-server 打开即可。
注意:修改 cofig 文件后需要重新
npm run build
才能生效安装 pandoc
我们使用 pandoc 来生成 Rap 的离线文档,安装 Pandoc 最通用的办法是在 pandoc 的 release 页面下载对应平台的二进制文件安装即可。
其中 linux 版本最好放在
/usr/local/bin/pandoc
让终端能直接找到,并执行 chmod +x /usr/local/bin/pandoc
给调用权限。
测试在命令行执行命令
pandoc -h
有响应即可。启动redis-server
redis-server
后台执行可以使用 nohup 或 pm2,这里推荐使用 pm2,下面命令会安装 pm2,并通过 pm2 来启动 redis 缓存服务
npm install -g pm2
npm run start:redis
先创建创建数据库
mysql -e 'CREATE DATABASE IF NOT EXISTS RAP2_DELOS_APP DEFAULT CHARSET utf8 COLLATE utf8_general_ci'
初始化
npm install
confirm configurations in /config/config.dev.js (used in development mode),确认/config/config.dev.js 中的配置(.dev.js 后缀表示用于开发模式)。
安装 && TypeScript 编译
npm install -g typescript
npm run build
初始化数据库表
npm run create-db
执行 mocha 测试用例和 js 代码规范检查
npm run check
启动开发模式的服务器 监视并在发生代码变更时自动重启
npm run dev
生产模式
# 1. 修改/config/config.prod.js中的服务器配置
# 2. 启动生产模式服务器
npm start