Yapi接口管理平台的配置和安装

 

一、Yapi 安装环境

系统：Windows10

安装环境：node环境+mongodb数据库（yapi系统需要部署在node环境中，且使用mongodb进行数据库存储。）

安装包版本：

Node：v10.5.0

MongoDB：v5.0.11

Yapi：1.9.2

二、Yapi安装步骤

1、Node及npm安装

1.node  下载地址   https://nodejs.org/download/release/v10.5.0/

 

 

 安装完成之后 将nodejs 添加到path 环境变量里

node 及npm版本查看命令

node  -v

npm -v

2.自定义node配置文件夹

   在node目录下新建两个文件夹node_cache和node_global

 

 

 配置node第三方命令地址：该配置加上系统环境变量配置，防止默认指向c盘的用户目录下，占用C盘空间

npm config set prefix "E:\tools\nodejs\node_global"

配置node下载时缓存地址：该配置用于设定node下载和查询，防止默认指向c盘的用户目录下，占用C盘空间

npm config set cache "E:\tools\nodejs\node_cache"

 

3.配置node的系统环境变量路径

变量名为：NODE_PATH
变量值为：E:\tools\nodejs\node_modules
也就是全局依赖包下的node_modules

注意:npm  安装yapi cli 的时候 淘宝镜像会报警告,可以变更下npm镜像地址 以及 ssl证书验证处理

1 ）清空缓存
npm cache clean --force
2） 查看当前的npm镜像设置
npm config get registry
3 ）切换新源
npm config set registry https://registry.npmmirror.com
4 ）查看新源是否设置成功
npm config get registry

5）解决npm证书验证问题
npm set strict-ssl=false

 

 

 

2、MongoDB安装

mongodb的下载路径   https://www.mongodb.com/try/download/community

 

 

 

 

MongoDB配置文件：server/5.0 / bin/ mongod.cfg

如果没有新建一个

# mongod.conf

# for documentation of all options, see:
#   http://docs.mongodb.org/manual/reference/configuration-options/

# Where and how to store data.
storage:
  dbPath: D:\Program Files\MongoDB\Server\5.0\data
  journal:
    enabled: true
#  engine:
#  wiredTiger:

# where to write logging data.
systemLog:
  destination: file
  logAppend: true
  path:  D:\Program Files\MongoDB\Server\5.0\log\mongod.log

# network interfaces
net:
  port: 27017
  bindIp: 127.0.0.1


#processManagement:

#security:

#operationProfiling:

#replication:

#sharding:

## Enterprise-Only Options:

#auditLog:

#snmp:

MongoDB环境变量配置：右击我的电脑>属性>高级系统设置>系统属性-高级-环境变量>系统变量-Path>新建：输入MongoDB安装bin目录路径即可。

如：C:\Program Files\MongoDB\Server\5.0bin

 

3、Yapi安装以及 pm2 运行yapi

yapi 版本 如果1.9.1不行就换1.10.1

1.使用npm安装yapi

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

2.启动yapi的安装服务

yapi server

3..获取npm包位置，并启动部署

启动服务

 

 

 

 

 

 

 4.访问登录

进入my-yapi目录

E:\tools\nodejs\node_global\my-yapi

node vendors/server/app.js

账号是邮箱，密码默认ymfe.org

 

5.Yapi配置pm2服务（以服务的形式运行）

 1.全局安装pm2

      npm install pm2 -g

2.配置pm2服务

pm2 start D:\YApi\my-yapi\vendors\server\app.js --name Yapi

以Yapi的名称命名并启动

3.常用命令

pm2 start Yapi
pm2 stop Yapi

4、Yapi以windows服务的形式运行

1. 工具准备
WinSW
在Windows下将Yapi注册成系统服务，需要借助 WinSW 这个工具。
下载链接:https://github.com/winsw/winsw/releases

根据自身Windows环境下载相应版本的exe文件。

2. 配置参数
新建一个xml文件，并在文件中写入以下内容。

<service>
<id>Yapi</id>
<name>Yapi</name>
<description>Yapi</description>
<executable>[node安装目录]\node.exe</executable>
<arguments>[yapi安装目录]\my-yapi\vendors\server\app.js</arguments>
<logpath>[yapi安装目录]\my-yapi\log\</logpath>
<logmode>roll</logmode>
</service>
注意需要根据自己的安装环境更改目录参数

将这个文本文件以及WinSW可执行文件移动到Yapi安装目录下的server文件夹下

[yapi安装目录]\my-yapi\vendors\server

并修改两个文件的名称为 Yapi-Service或者其他任意名称，但需保证两个文件名称相同。

 

 

3. 安装服务
cmd命令进入文件夹

[yapi安装目录]\my-yapi\vendors\server

输入以下命令后回车

Yapi-Service.exe install

控制台显示

Service ‘Yapi (Yapi)’ was installed successfully.