YApi内部部署文档

YApi

旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API

1、安装Node.js环境(7.6+)

1、官网下载适合的nodejs版本放置在/usr/package,后缀为.tar.xz,需要使用xz -d先解压成.tar文件,在使用tar解压

2、官网下载的是已经编译过的软件包,可以直接在bin目录下执行 ./node -v

3、执行 ln -s /usr/local/nodejs/bin/node /usr/local/bin/node 命令将node命令设置为全局,此时即可全局使用node命令

4、执行 ln -s /usr/local/nodejs/bin/npm /usr/local/bin/npm 命令将npm命令设置为全局,此时即可全局使用npm命令

2、安装MongoDB(2.6+)

1、可在官网下载软件包或使用如下命令

curl -Ohttps://fastdl.mongodb.org/linux/mongodb-linux-x86_64-3.0.6.tgz    # 下载

tar -zxvf mongodb-linux-x86_64-3.0.6.tgz                                                     # 解压

mv  mongodb-linux-x86_64-3.0.6/ /usr/local/mongodb                                 # 将解压包拷贝到指定目录

2、MongoDB 的可执行文件位于 bin 目录下,所以可以将其添加到 PATH 路径中:

export PATH=/usr/local/mongodb/bin:$PATH

3、MongoDB的数据存储在data目录的db目录下,但是这个目录在安装过程不会自动创建,所以你需要手动创建data目录,并在data目录中创建db目录。

这里我们将data创建在mongodb目录下

注意:/data/db 是 MongoDB 默认的启动的数据库路径(--dbpath),所以后续启动时要用--dbpath指定用我们自己创建的data目录启动

mkdir -p /usr/local/mongodb/data/db

4、在/usr/local/mongodb目录下新建启动命令start_mongodb.sh

nohup ./bin/mongod --dbpath=/usr/local/mongodb/data/db &

5、在/usr/local/mongodb目录下新建启动命令connect_mongodb.sh

./bin/mongo

执行./connect_mongodb.sh 进入数据库,可用show dbs命令看到默认一般只有一个test数据库,此时单独创建一个yapi数据库用于使用

执行 user yapi ,不存在是会自动创建,创建之后输入 db,可看到当前数据库已变更为yapi

6、创建一个yapi用户用与连接

db.createUser({user:'yapi',pwd:'xxxxxxx', roles:[{role:'dbAdmin', db:'yapi'}]})

3、安装yapi

1、mkdir yapi, cd yapi执行

git clonehttps://github.com/YMFE/yapi.gitvendors //或者下载 zip 包解压到 vendors 目录

cp vendors/config_example.json ./config.json //复制完成后请修改相关配置

cd vendors

2、vendors目录下 安装yapi工具包

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

3、vendors目录下 安装Node模块,如果之前没有安装过git,则需要安装 yum install git,同时需要给/usr/local/yapi/vendors/node_modules目录设置读写权限

npm install --production --registryhttps://registry.npm.taobao.org

4、vendors目录下 安装yapi软件 

npm run install-server

此时会提示初始化管理员账号成功

5、yapi目录配置启动命令start_yapi.sh

nohup node vendors/server/app.js &

4、更新yapi版本

1、首先可在Node目录下将yapi命令设置为全局

ln -s /usr/local/nodejs/bin/yapi /usr/local/bin/yapi

2、在yapi目录下执行 

yapi ls 查看版本号列表

yapi update //升级到最新版本

yapi update -v v1.1.0 //升级到指定版本

3、更新之后需要重启,官方推荐使用pm2来管理,也可以直接使用杀死Node进程来重启

你可能感兴趣的:(YApi内部部署文档)