yapi的安装及其项目的创建和启动

官网地址：https://github.com/YMFE/yapi

前言/官网

官网 https://github.com/ymfe/yapi

一、安装yapi

使用yapi-cli 工具，部署 YApi 平台。

命令如下：

npm install -g yapi-cli --registry https://registry.npm.taobao.org	# 需要 nodejs环境
yapi server																													# 需要 MongoDB环境

虽然只有两个命令，但是两个命令的执行分别需要nodejs环境和MongoDB环境。

所以，使用这两个命令前，我们先按需依次完成以下步骤，搭建yapi所需的nodejs环境和MongoDB环境。

二、yapi所需环境nodejs的安装

1、nodejs环境的检测

node -v

如果能够执行此命令，则代表你已安装nodejs的环境，请不用再重复安装。如果没有，请看下一步3、nodejs环境的安装。

2、未安装nodejs环境，导致的yapi安装失败

因为安装yapi的 npm install -g yapi-cli --registry https://registry.npm.taobao.org 那条命令，需要用到npm环境。如果没安装，则会失败如下：

所以请先检测您电脑是否已经安装了nodejs（7.6+)了。

3、nodejs环境的安装

安装nodejs（7.6+)。另关于node的安装，请查看本网站中的node.md

三、yapi所需环境MongoDB的安装与启动

1、未配MongoDB环境，导致的yapi安装失败

执行部署yapi的 yapi server 命令时候，此时看到的执行结果如下：

如果你未提前安装mongodb，则会在部署yapi的时候发生如下错误。

所以要完成yapi的成功部署，其还需要 mongodb（2.6+）

2、MongoDB环境的检测

mongo -version

如果能够执行此命令，则代表你已安装mongodb的环境，请不用再重复安装。如果没有，请看3、yapi所需环境MongoDB的安装。

3、yapi所需环境MongoDB的安装

方法一、可视化桌面安装

如果您是云服务器ECS，请跳过方法一，直接使用方法二终端命令安装MongoDB。

其他参考见：Mac OSX 平台安装 MongoDB

在Mac 安装MongoDB

1、点击进入下载地址https://www.mongodb.com/download-center/enterprise

将下载下来的tgz解压后，放到/usr/local文件夹中，并改名为mongodb。

在改名为mongodb后，通过在终端执行open ~，找到并打开该目录下的.bash_profile中配置如下环境变量

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

配置完后，关闭文件，终端执行如下命令，使得钢材配置的环境变量能够生效。

cd ~
source ./.bash_profile


# 或者直接下面一句
source  ~/.bash_profile

不执行 上述source命令的话， mongo -version 无法生效。

安装成功后，执行mongo -version，如果不提示 command not found，代表安装成功了。

至此，mongo安装完成，接下去进行启动mongo。

方法二、终端命令安装MongoDB(云服务器常用的安装方式)

Linux平台安装MongoDB官网安装文档 https://www.runoob.com/mongodb/mongodb-linux-install.html

进入地址：https://www.mongodb.com/try/download/community

cd 到某个目录，执行以下命令,下载文件
yum install libcurl openssl
wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel80-4.4.1.tgz

1、找到并提前测试所下载的mongodb能否在本操作系统下有效执行。如果无效，会出现以下错误

-bash: ./mongo: cannot execute binary file: Exec format error

查看系统是几位的终端命令为getconf LONG_BIT

测试方法：

# 1、使用wget下载

# 2、使用tar -zxvf解压缩后

# 3、直接进入解压缩后的mongodb的bin目录下，执行对应的命令

2、有效后，再转移并设置环境变量

tar -zxvf mongodb-linux-x86_64-rhel80-4.4.1.tgz

mv mongodb-linux-x86_64-rhel80-4.4.1 /usr/local/mongodb

输入vim /etc/profile编辑环境变量文件

# set for mongo
export PATH=/usr/local/mongodb/bin:$PATH

插入完成后，执行source /etc/profile，使环境变量生效，之后执行以下命令，就可以看到有效了。

mongo -version

4、yapi所需环境MongoDB的启动

命令认识：

# --dbpath 设置数据存放目录
# --logpath 设置日志存放目录
# --fork 在后台运行

# mongod --dbpath <path to data directory> 																					# 基础的运行命令
# mongod --dbpath <path to data directory> --logpath <path to log directory> --fork # 后台的运行命令（如果要--fork，则必须有--logpath参数）

方法一：可视化桌面操作(以MacOS为例)

1、为MongoDB创建数据(必需)及日志存放的目录(可选)

步骤：为MongoDB创建数据及日志存放的目录，这里我们就把它们放在/usr/local/var目录下。

创建数据目录： /usr/local/var/mongodb

创建日志存放的目录：/usr/local/var/log/mongodb

2、执行命令启动 mongodb

数据(必需)及日志存放的目录创建完成后，输入如下命令：

# --dbpath 设置数据存放目录
# --logpath 设置日志存放目录
# --fork 在后台运行
mongod --dbpath /usr/local/var/mongodb --logpath /usr/local/var/log/mongodb/mongo.log --fork

或
cd /usr/local/var/
mongod --dbpath ./mongodb --logpath ./log/mongodb/mongo.log --fork

方法二：终端命令操作(常用于云服务器)

1、为MongoDB创建数据(必需)及日志存放的目录(可选)

步骤：为MongoDB创建数据及日志存放的目录，这里我们新建一个单独的文件夹，如CQApp-api-mongodb来单独存放yapi的数据及日志。

# 创建存放的目录
cd Project
mkdir CQApp-api-mongodb

# 创建数据目录data
sudo mkdir -p data
sudo chown -R 777 data

# 创建日志存放的目录log
sudo mkdir -p log
sudo chown -R 777 log

生成后，文件如下：

2、执行命令启动 mongodb

cd Project/CQApp-api-mongodb/
mongod --dbpath ./data --logpath ./log/mongo.log --fork

5、mongodb启动成功后，即可重新点击之前的开始部署/开始创建yapi项目。

6、yapi所需环境MongoDB的关闭

# 对于处理后台启动的mogodb的关闭，使用以下命令来关闭
pkill mongod

# 其他前台的，直接退出终端或者Ctrl+C结束就行了。

四、创建yapi项目

1、执行部署yapi的 yapi server 命令

yapi server

2、访问http://0.0.0.0:9090，

此时看到的结果如下：

3、点击开始部署，

执行过程如下：

4、部署/创建成功

部署/创建成功，截图如下：

账号：admin@admin.com

密码：ymfe.org

这个账号密码，待会需要用于登录yapi网页界面使用。

此时你所填写的部署路径下，就会有所创建生成的yapi工程。

附：执行后mongodb config1

五、yapi的项目运行

请查看 本博客中的yapi的项目运行.md

End