免费开源API接口文档管理工具YApi安装详细教程

YAPi简介

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

环境要求

nodejs（7.6+)
mongodb（2.6+）
git
git在Linux服务器安装比较简单执行一下命令

yum install -y git
git --version

安装nodejs

• 下载安装包

wget https://npm.taobao.org/mirrors/node/v10.15.3/node-v10.15.3-linux-x64.tar.xz 

下载完成界面如下：

• 解压安装包并重命名

tar -xvf node-v10.15.3-linux-x64.tar.xz -C /soft/server/
cd /soft/server
mv node-v10.15.3-linux-x64/ nodeJs

• 配置nodejs的环境变量

vim /etc/profile
在文件末尾添加一下两项配置
export NODEJS_HOME=/soft/server/nodeJs
export PATH=$PATH:$NODEJS_HOME/bin
source /etc/profile 

• 验证环境变量
  执行node -v,执行效果图如下，则配置成功。
  

安装 mongodb

• 下载安装包

wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-amazon-3.6.3.tgz

• 解压安装包并重命名

tar -zxvf mongodb-linux-x86_64-amazon-3.6.3.tgz -C /soft/server/
将文件命名为mongodb
mv mongodb-linux-x86_64-amazon-3.6.3 mongodb

• 配置mongodb的环境变量

vim /etc/profile
在文件末尾添加一下两项配置
export MONGODB_HOME=/soft/server/mongodb
export PATH=$PATH:$MONGODB_HOM/bin
source /etc/profile 

• 验证环境变量
  执行mongod -v,执行效果图如下，则配置成功。
  
• 配置mongodb

cd /soft/server/mongodb
mkdir data
mkdir log
mkdir conf
cd conf
vim mongodb.conf

添加一下配置，如下图所示：

这里简单介绍一下mongodb配置文件参数：

参数	释义
dbpath	数据库路径(数据文件)
logpath	日志保存目录
logappend	日志文件末尾添加
port	启动的端口号
fork	后台运行
auth	是否认证验证权限登陆
bind_ip	设置绑定的ip地址

更多配置可参考官网的配置，这里不在详细介绍。

• 启动mongodb
  执行mongod -f ./mongodb.conf 若执行效果如下，则mongoDb安装成功。
  
  到此为止mongodb安装成功。
• 配置yapi的用户和密码

use yapi

db.createUser(
    {
        user: "test1",
        pwd: "test1",
        roles: [ { role: "readWrite", db: "yapi" } ]
    }
)

执行效果如下图：

安装YAPI

本人安装是命令行安装的，开始按照官方文档安装，结果没有安装成功。报了这样的错误：
gyp WARN EACCES user "root" does not have permission to access the dev dir“XX” 的错误,解决方法如下：

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors 
cp vendors/config_example.json ./config.json
cd vendors
// 解决如下，注意一定要带上--unsafe-perm，否则安装可能不会成功
npm config set registry https://registry.npm.taobao.org
npm install --production --registry https://registry.npm.taobao.org --unsafe-perm
//安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
npm run install-server
// 后台运行yapi，否则关闭窗口后，yapi退出运行
node server/app.js  >/dev/null 2>&1 &

启动后，默认管理员账号名："[email protected]"，密码："ymfe.org"，这个可以在config.json文件中修改，修改后，重启服务即可。
访问地址：你的ip+3000端口号，如下图所示：

yapi的使用

具体使用可以参考官方的文档，yapi教程 https://yapi.ymfe.org/documents/index.html ，打完收工。