目录
一、Yapi 简介
1、Yapi是什么？
Yapi 由 YMFE开源，旨在为开发、产品、测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布、维护API。
YAPI 是由去哪儿网移动架构组(简称YMFE，一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开发的可视化接口管理工具，是一个可本地部署的、打通前后端及QA的接口管理平台。有了YAPI，我们可以很方便的测试、管理和维护多个项目的API接口，YAPI是一个独立的服务平台。
2、Yapi的主要功能简介
权限管理：YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求
可视化接口管理：基于 websocket的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率
Mock Server：易用的 Mock Server，再也不用担心 mock 数据的生成了
自动化测试：完善的接口自动化测试，保证数据的正确性
数据导入：支持导入swagger，postman，har，json数据格式，方便迁移旧项目
插件机制：强大的插件机制，满足各类业务需求
Yapi支持内网部署：只需在管理员或内网某台机器上安装部署一次，团队其他成员不需要部署，访问相应的地址即可使用。
二、Yapi 安装环境
系统：Windows10
安装环境：node环境+mongodb数据库（yapi系统需要部署在node环境中，且使用mongodb进行数据库存储。）
安装包版本：
Node：v12.18.3
npm：6.14.8（Node Package Manager，Node包管理工具）
MongoDB：v4.2.17
Yapi：1.9.2
以上是本文的安装包版本，建议按照以上版本使用，以免出现其他报错，影响正常安装。
三、Yapi安装步骤
1、Node及npm安装
Node下载地址：https://nodejs.org/download/release/v12.18.3/
Node安装：根据自己的系统版本下载.msi安装包，下载完成后点击安装，然后直接next就好。
注意：
- 遇到该勾选的勾选了就行
- 安装过程中记得将nodejs添加至环境路径
- 安装路径的话默认就好
- 安装完成后，在命令行输入path，查看node.js是否已被添加至系统环境变量
node及npm版本查看命令：
// 命令输入环境：Windows系统下的 cmd 命令窗口
node -v // 查看node当前安装版本
npm -v //查看npm当前安装版本npm升级及安装指定版本命令：
// 命令输入环境：Windows系统下的 cmd 命令窗口
npm install -g npm // 安装最新版本
npm -g install npm@6.14.8 // 安装指定版本Node及npm版本查看截图：
2、MongoDB安装
MongoDB下载地址：MongoDB Community Download | MongoDB
MongoDB安装：下载需要的.msi文件后，双击进入安装界面，直接都点击下一步好了。
MongoDB默认安装目录：C:\Program Files\MongoDB\Server\4.2
MongoDB目录结构截图：
MongoDB配置文件：mongod.cfg
注意：没有的话可以自己创建一个mongod.cfg文件，使用notepadd++编辑器编辑。
# mongod.conf
# for documentation of all options, see:
# http://docs.mongodb.org/manual/reference/configuration-options/
# Where and how to store data.
storage:
dbPath: C:\Program Files\MongoDB\Server\4.2\data
journal:
enabled: true
# engine:
# mmapv1:
# wiredTiger:
# where to write logging data.
systemLog:
destination: file
logAppend: true
path: C:\Program Files\MongoDB\Server\4.2\log\mongod.log
# network interfaces
net:
port: 27017
bindIp: 127.0.0.1MongoDB环境变量配置：右击我的电脑>属性>高级系统设置>系统属性-高级-环境变量>系统变量-Path>新建：输入MongoDB安装bin目录路径即可。
如：C:\Program Files\MongoDB\Server\4.2\bin
MongoDB版本查看命令：
打开MongoDB安装bin目录，并在目录路径中输入cmd，打开命令窗口（这样打开就直接在改路径下了，就不需要再次通过cd切换到MongoDB安装bin目录了）
// 命令输入环境：Windows系统下的 cmd 命令窗口
mongo --version // 查看MongoDB当前安装版本MongoDB启动命令：
// 命令输入环境：Windows系统下的 cmd 命令窗口
net start mongodb // MongoDB服务启动命令
MongoDB 数据库连接命令：
// 命令输入环境：Windows系统下的 cmd 命令窗口
mongo // 连接数据库
show databases // 查询数据库
exit // 退出数据库连接
至此 MongoDB数据库已经准备就绪了！可以进行下一步操作了——安装Yapi。
3、Yapi安装
Yapi仓库地址：YApi: YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务
Yapi内网部署介绍：内网部署
这里介绍方式一：执行 yapi server 启动可视化部署程序部署
npm安装Yapi命令：
// 命令输入环境：Windows系统下的 cmd 命令窗口
npm install -g yapi-cli --registry https://registry.npm.taobao.org // 在线安装Yapi启动Yapi服务命令：
// 命令输入环境：Windows系统下的 cmd 命令窗口
yapi server // 启动Yapi服务
浏览器打开：http://localhost:9090/，进入yapi的配置安装服务。
注意：
- 选择需要安装的版本，最好用本文章提供的版本，以免出现其他报错
- 填写好公司的名称，可以自定义
- 填写好管理员邮箱，也可以不填默认为admin@admin.com（后面可以配置）
- 记住Yapi安装路径，如：C:\Users\Administrator\my-yapi
填写好以上内容后，点击“开始部署”按钮，进行部署；部署成功后，就是node启动yapi服务啦。
Yapi的目录结构图：
node启动Yapi服务：
在yapi安装目录中输入cmd，打开命令行窗口，输入启动yapi服务命令：
node vendors/server/app.js // 启动yapi服务浏览器访问 http://localhost:3000 或 http://127.0.0.1:3000
账号名：你设置的邮箱，初次管理员登录密码为：ymfe.org
至此 Windows系统下 Yapi 安装全部结束了！
如果你安装中有问题可以问百度开发者搜索-Beta-让技术搜索更简单高效
最后，局域网内部yapi使用：同一局域网下的同伴可以使用你的ip地址加上端口号即可进行访问。
// 命令输入环境：Windows系统下的 cmd 命令窗口
ipconfig // 查看你自己的ip，一般为192.168.0.x
// 则浏览器中输入 192.168.0.x:3000 即可访问到yapi系统主页了。本地启动Yapi服务步骤：
1）进入MongoDB安装bin目录，cmd打开第一个命令行窗口
——启动MongoDB数据库：net start mongodb
2）同命令行窗口输入命令：yapi server，启动 yapi部署环境服务
3）进入yapi安装目录my-yapi，cmd打开第二个命令行窗口
——启动yapi：node vendors/server/app.js
4）打开浏览器，输入：http://127.0.0.1:3000/，登录即可访问主页。
本地启动Yapi服务截图：
四、Yapi使用简介
Yapi使用教程地址： YApi-教程
此处不再赘述。
4564
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
