一. 简单的介绍
YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
———摘自YAPI官网。
我的理解:
其实就是一个接口管理平台,它可以从swagger,等导入数据。也可以自己在页面上新建接口,编辑接口信息。并和postman,swagger一样的请求接口。
二.轻易的安装
1.nodejs安装
yapi系统需要部署在node环境,所以得安装这玩意。嗯,新手只需要知道这个。就行java代码运行需要jdk一样。
下载:https://nodejs.org/zh-cn/download/
这里建议大家不要太高版本,我用的是10.5.0,一开始用的16没有成功,
大家可以根据自己的系统版本进行选择安装,这里小编下载的是.msi安装包,这种安装方式比较简单,下载完成后点击安装,然后直接next就好。遇到该勾选的勾选了就行。还有安装过程中记得将nodejs添加至环境路径呀。安装路径的话默认就好,毕竟不是专业搞node开发的,占用不了多少内存空间。
安装完成后,在命令行输入path,查看node.js是否已被添加至系统环境变量。
node -v // 查看node版本
npm -v // 查看npm版本
2.MongoDB安装
下载 https://www.mongodb.com/try/download/community
yapi的使用的是mongodb进行数据库存储。包括账户信息,api的接口信息等。所以需要安装mongodb数据库,否则是无法初始化yapi的安装过程的。
就下载最新版吧,反正小编安装最新版没问题。
下载完成后,双击下载的.msi文件,即可进入安装界面。直接都点击下一步好了,如果有强迫症的可以选择custom自定义安装位置。我是无脑下一步,所以mongodb的服务所在位置就是C盘了呀。安装成功后,目录结构如下。
配置mongodb
如果安装目录下没有mongod.cfg的同学,自己创建一个。如果有的话就直接打卡配置,可以使用notepadd++,或者sublimetext这两款编辑器编辑
storage:
dbPath: C:\Program Files\MongoDB\Server\4.2\data //数据存储路径,建议改到非系统盘,该路径下会根据数据库信息自动创建文件夹和相应的文件
journal:
enabled: true
# 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.1 //绑定 端口和ip
将mongodb加入系统环境路径
启动mongodb
net start mongodb
测试mongodb连接
mongo
3.安装Yapi
使用npm安装yapi
npm install -g yapi-cli --registry https://registry.npm.taobao.org
启动yapi的安装服务
yapi server
这时,可以浏览器访问
localhost:9090
填写好公公司名称,管理员邮箱就可以点击开始部署了。如果部署出现问题,也可以根据提示进行解决。
部署成功后,就可以是node启动yapi服务啦。
cd C:\Windows\System32\my-yapi
node vendors/server/app.js //启动指令
浏览器访问 http://localhost:3000,
账号名:你设置的邮箱,初次管理员登录密码为:ymfe.org
.
可能出现的问题
1.一直部署不成功
需要MongoDB用管理员启动,启动yapi前一定要启动MongoDB数据库,找到bin下的exe文件,右键管理员运行就可. 启动yapi一样要用管理员启动,用管理员命令找到my-yapi路径,再输入启动命令.
另外部署中也可能出现别的错误,
根据提示自己百度
部署成功是这样的
2.启动yapi报错
缺少的文件,直接npm下载即可
原文转自:http://t.csdn.cn/TIILI
版权归原作者 江蜀黍 所有, 如有侵权,请联系我们删除。