yapi接口文档初步搭建

近期呢，公司来了一个小白自动化测试，带带她的同时，觉得整理一份好的接口文档还是非常必要的，于是下面接介绍如何搭建接口文档，市面上接口文档有很多，这边我们使用yapi。

 

首先我们需要一台服务器去搭建，这里我的系统是centos的阿里云服务器。要安装以下三个模块

（1）nodejs

（2）git

（3）mongo

 

第一步安装nodejs：

curl -sL https://rpm.nodesource.com/setup_10.x | bash -

yum install -y nodejs

第二步git安装：

yum -y install git

第三步mongo安装：

cd /usr
wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-4.0.0.tgz
tar zxvf mongodb-linux-x86_64-4.0.0.tgz
mv mongodb-linux-x86_64-4.0.0 mongodb


vim /etc/profile
在 export PATH USER LOGNAME MAIL HOSTNAME HISTSIZE HISTCONTROL 一行的上面添加如下内容:
set Mongodb
export PATH=/usr/mongodb/bin:$PATH

保存后通过下面的命令使环境变量生效：
cd ~
source /etc/profile

创建数据库目录
cd /usr/mongodb
touch mongodb.conf
mkdir db
mkdir log
cd log
touch mongodb.log

vim /usr/mongodb/mongodb.conf
#贴下以下配置
port=27017 #端口
dbpath= /usr/mongodb/db #数据库存文件存放目录
logpath= /usr/mongodb/log/mongodb.log #日志文件存放路径
logappend=true #使用追加的方式写日志
fork=true #以守护进程的方式运行，创建服务器进程
maxConns=100 #最大同时连接数
noauth=true #不启用验证
journal=true #每次写入会记录一条操作日志（通过journal可以重新构造出写入的数据）。
#即使宕机，启动时wiredtiger会先将数据恢复到最近一次的checkpoint点，然后重放后续的journal日志来恢复。
storageEngine=wiredTiger  #存储引擎有mmapv1、wiretiger、mongorocks
bind_ip = 0.0.0.0  #这样就可外部访问了，例如从win10中去连虚拟机中的MongoDB

设置文件夹权限
cd /usr/mongodb
chmod 777 db
chmod 777 log

启动mongodb
cd ~
mongod --config /usr/mongodb/mongodb.conf

 

安装成功之后以上三个，就可以安装yapi啦。

#安装以及启动
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

会提示以下内容

 

 

 

于是打开这个服务器地址:9090 就可以配置和部署啦 

 

 

 

 然后终端出现这个 接下来按提示操作即可

 

 

于是新开一个窗口 

cd my-yapi/
node vendors/server/app.js

会提示以下内容

 

 

看到这里基本就可以啦

 

 

 

 于是就搭建好啦 个人比较喜欢用yapi，于是记录一个笔记，也方便后期自己查阅

 

 

 

对哦如果想配置开机自启动，vi /etc/rc.local 然后保存退出

 

cd ~
/usr/mongodb/bin/mongod --config /usr/mongodb/mongodb.conf
cd ~/my-yapi/
nohup node vendors/server/app.js > yapi.log 2>&1 & exit

然后你会发现重启之后并不生效，为什么呢，原因如下

 

 

 

执行 

chmod +x /etc/rc.d/rc.local 即可，重启生效

 

 

 

ps：各种报错处理

今天我在新的服务器又重新安装之后，yapi报错咋处理呢，看以下

 

 首先很简单我就试着注释一下

（1）打开/root/my-yapi/vendors/server/utils/commons.js文件，将所谓的jsf.extend给注释掉。

cd /root/my-yapi/vendors/server/utils/    # 进入utils目录
vi commons.js                             # 编辑common.js

 

 然后保存退出

（2）回到命令行，ctrl+c 停止之前进度进入之前创建的项目文件夹的vendors 目录，执行 node server/install.js

cd vendors/                                # 进入vendors目录
node server/install.js                     # 执行安装js
node server/app.js                         # 启动yapi

然后可以啦

 

有时候npm安装之后，你运行yapi server 会提示找不到yapi这个命令，这里有些时候你可能需要按提示做一个软连接关联即可