YAPI部署及使用文档

YAPI的部署及使用

枕微凉

3464人浏览 · 2022-11-17 13:54:17

枕微凉 · 2022-11-17 13:54:17 发布

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

1.部署

所需环境：node.js+mongodb+yapi

1.1 安装node.js（7.6+）

使用淘宝镜像源下载包

wget https://npm.taobao.org/mirrors/node/v12.12.0/node-v12.12.0-linux-x64.tar.gz

解压并重命名

tar -xvf node-v12.12.0-linux-x64.tar.gz
mv node-v12.12.0-linux-x64.tar.gz node

加入变量
```
sudo vim /etc/profile
```

添加以下内容后保存并退出

# node.js
export NODE_HOME=<node文件夹路径>
export PATH=$NODE_HOME/bin:$PATH

刷新
```
source /etc/profile
```
测试
```
node -v
npm -v
```

1.2 安装mongodb（2.6+）

使用淘宝镜像源下载包

wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-5.0.3.tgz

解压并重命名

tar -xvf mongodb-linux-x86_64-rhel70-5.0.3.tgz
mv mongodb-linux-x86_64-rhel70-5.0.3.tgz mongodb

加入变量
```
sudo vim /etc/profile
```

添加以下内容后保存并退出

# mongodb
export PATH=<MongoDB 的文件夹路径>/bin:$PATH

刷新
```
source /etc/profile
```

进入MongoDB 的文件夹路径创建必要文件夹 db 和 log，并修改其权限

cd <MongoDB 的文件夹路径>
mkdir db && mkdir log
chmod 777 db && chmod 777 log

创建配置文件

touch mongodb.conf
cd log && touch mongodb.log

修改配置文件

vim /<mongodb目录地址>/mongodb.conf

加入一下内容

port=27017                                     #服务的端口号
dbpath=<MongoDB 的文件夹路径>/db                #数据库存文件存放目录
logpath=<MongoDB 的文件夹路径>/log/mongodb.log  #日志文件存放路径
logappend=true                                 #使用追加的方式写日志
fork=true                                      #以守护进程的方式运行，创建服务器进程
maxConns=100                                   #最大同时连接数
journal=true                                   #每次写入会记录一条操作日志（通过journal可以重新构造出写入的数据）。 即使宕机，启动时wiredtiger会先将数据恢复到最近一次的checkpoint点，然后重放后续的journal日志来恢复。
storageEngine=wiredTiger                       #存储引擎有mmapv1、wiretiger、mongorocks
bind_ip=0.0.0.0                                #设置0.0.0.0外网才可以访问
auth=false                                     #校验权限，这是为 true yapi 会链接不上

启动 ,出现started successfully…即为成功

# mongod --config /<mongodb目录地址>/mongodb.conf
mongod --config /usr/local/mongodb/mongodb.conf

1.3 安装yapi （官方安装文档地址）

官方推荐使用可视化安装，以下也使用以下方法

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

使用浏览器登录：IP:9090
填写完成点击开始部署，命令行出现以下即表示完成

在这里插入图片描述

要保证后台保持进程，需要安装pm2

npm install pm2 -g  //安装pm2
cd  {项目目录}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务

在这里插入图片描述