win10 x64下从0开始搭建YApi可视化接口管理平台

时间:2022-07-25
本文章向大家介绍win10 x64下从0开始搭建YApi可视化接口管理平台，主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项，具有一定的参考价值，需要的朋友可以参考一下。

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

特性

  • 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
  • 扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
  • 不仅有类似 postman 的接口调试，还有强大的测试集功能
  • 免费开源，内网部署，信息再也不怕泄露了！
  • 支持 postman, har, swagger 数据导入

一、环境准备

1、nodejs

2、mongodb

3、Git

4、YApi

二、Git安装

1、Git官网下载：https://git-scm.com/downloads

2、直接下一步、下一版安装即可

三、node安装

1、进入官网：https://nodejs.org/en/download/

2、下载后进行安装，直接下一步、下一步安装

3、安装成功后，可在cmd窗口中输入：node --version查看版本号

4、在cmd窗口输入：npm -v，查看npm的版本号

四、安装MongoDB

1、进入官网

https://www.mongodb.com/try/download/community?jmp=nav

假如下载速度过慢，可以使用下面的路径

http://dl.mongodb.org/dl/win32/x86_64

这里选择如下，下载后进行安装

2、安装也是比较简单的，选择【custom】,安装路径自定义，记住就好，后面配置会用到，一路点击next，

3、下一步,安装 "install mongoDB compass" 不勾选，否则可能要很长时间都一直在执行安装，MongoDB Compass 是一个图形界面管理工具，我们可以在后面自己到官网下载安装，下载地址：https://www.mongodb.com/download-center/compass，当然，网络较好的情况下可以勾选安装

4、配置Mongodb

在您安装mogodb的根目录下，新增data、logs和etc文件，

A、新增data文件夹，D:pythonmongoDBdata

B、新增logs文件夹，D:pythonmongoDBlogs，在文件夹下新增一个mongo.log文件

C、新增etc文件夹，D:pythonmongoDBetc，在文件夹下新增一个mongo.conf文件

在mongo.conf文件中输入如下数据：


#数据库路径
dbpath=D:pythonmongoDBdata
#日志输出文件路径
logpath=D:pythonmongoDBlogsmongodb.log
#错误日志采用追加模式，配置这个选项后mongodb的日志会追加到现有的日志文件，而不是从新创建一个新文件
logappend=true
#启用日志文件，默认启用
journal=true
#这个选项可以过滤掉一些无用的日志信息，若需要调试使用请设置为false
quiet=false
#端口号 默认为27017
port=27017

注意：如果你建的文件夹跟我的位置不一样，请修改上面文件中的地址。此文件的作用在后面再说。（32位的可能需要添加 storageEngine=mmapv1，指定存储引擎）

五、启动MongoDB

1、以管理员的身份，打开cmd窗口，进入mongodb的bin目录下（当前我的目录是D:pythonmongoDBbin），输入如下指令：

mongod --dbpath  D:pythonmongoDBdata

当看到有waiting for connections on port 27017标识，说明启动成功，在浏览器中输入：localhost:27017,可以查看到启动成功的画面

2、再次以管理员身份，新开启一个cmd窗口，进入mongodebin目录下，启动mongo,查看数据库等信息

细心的伙伴或许已发现，不能没错启动mongodb都是这样，开启两个管理员身份的cmd窗口、输入指令吧，这很容易忘和输错的，下面看看如何进行配置

六、配置启动文件

1、前面我们在etc文件夹里建了一个mongo.conf文件，这个文件的内容就是把一些配置设定好了，我们可以直接通过配置文件启动MongoDB，同时安装到window服务中。

进入bin目录下，输入指令：

mongod --config D:pythonmongoDBetcmongo.conf --install --serviceName "MongoDB"

参数说明：

–config  指定配置文件；–install --serviceName "MongoDB"是安装到window服务中；

2、查看本地服务

输入启动指令：

net  start MongoDB 启动服务

然后输入

mongo和show dbs,即可查和操作看数据库

同时查看浏览器页面显示

其他相关操作服务指令：

关闭指令：

net stop MongoDB

删除指令：

mongod --config c:MongoDBetcmongo.conf --remove

3、配置到系统环境变量

七、安装部署YApi

前提：已安装上面的所需环境：Git、MongoDB、nodejs

1、下载源码

  • Yapi源码地址：https://github.com/YMFE/yapi
  • 如果Yapi源码地址下载较慢，可以选择码云的Yapi源码地址下载：https://gitee.com/mirrors/YApi

2、部署YApi

a.进入下载解压后的YApi源码根目录下，我的是在D:pythonYApiyapi

b.输入指令进行安装，

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

c.输入启动服务指令，并配置本机的host配置如下：yapi server

d.在浏览器中输入http://localhost:9090/，查看页面是否能正常打开

e.假如网页不能正常打开，请输入如下指令，然后再次打开浏览器查看页面是否正常打开

npm install -g yapi-cliyapi  server

3、设定好公司名称、路径和邮箱等必填项，点击【开始部署】，进行部署

注：这里会出现两个问题
1>.提示如下错误
gyp ERR! find VS
gyp ERR! find VS msvs_version not set from command line or npm config
gyp ERR! find VS VCINSTALLDIR not set, not running in VS Command Prompt
gyp ERR! find VS could not use PowerShell to find Visual Studio 2017 or newer
gyp ERR! find VS looking for Visual Studio 2015
gyp ERR! find VS - not found
gyp ERR! find VS not looking for VS2013 as it is only supported up to Node.js 8
gyp ERR! find VS
gyp ERR! find VS **************************************************************
gyp ERR! find VS You need to install the latest version of Visual Studio
gyp ERR! find VS including the "Desktop development with C++" workload.
gyp ERR! find VS For more information consult the documentation at:
gyp ERR! find VS https://github.com/nodejs/node-gyp#on-windows
gyp ERR! find VS **************************************************************
解决办法：
以管理员的身份打开CMD，然后执行命令安装Visual Studio
npm install -g node-gyp
npm install --global --production windows-build-tools

2>.提示
Error:  (node:14532) UnhandledPromiseRejectionWarning: Error: 初始化管理员账号 "admin@admin.com" 管理员, E11000 duplicate key error collection: yapi.user index: email_1 dup key: { : "admin@admin.com" }
    at D:pythonYApiyapimy_yapivendorsserverinstall.js:146:17
    at processTicksAndRejections (internal/process/task_queues.js:94:5)
解决办法：
在部署前，不要使用默认邮箱地址，改成自己的QQ或者163邮箱，重新部署即可

4、部署完成后的结果如下

5、部署完成后，切换到部署目录下：D:pythonYApiyapimy_yapi

然后执行指令：

node vendors/server/app.js

6、在浏览器中输入网址，查看是否完成部署成功，【默认帐号：admin@admin.com，默认密码：ymfe.org】成功如下图所示

八、升级YApi版本

1、进入YApi安装目录，输入指令：

yapi ls

，查看所有版本号

2、执行更新指令

yapi update  //更新到最新版本yapi update -v {Version}  //更新到指定版本

九、设定YApi后台运行

如果使用node vendors/server/app.js启动Yapi服务的话，如果我们把cmd窗口关闭了，这时候我们就无法访问Yapi了。PM2是node进程管理工具，可以利用它来简化很多node应用管理的繁琐任务，如性能监控、自动重启、负载均衡等，而且使用非常简单。这时候我们就可以使用 pm2 管理 node 服务器启动、停止。

1、安装pm2

npm  i -g  pm2

2、后台启动或关闭YApi服务

pm2管理yapi服务，进入YApi的安装目录：D:pythonYApiyapimy_yapi

启动服务，执行指令：

pm2 start "vendors/server/app.js" --name yapi

关闭服务，执行指令：

pm2 stop "vendors/server/app.js" --name yapi

这样，pm2就可以管理YApi服务了，pm2常用的基本指令有：

pm2 info yapi //查看服务信息
pm2 start yapi //停止服务
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务

十、创建项目

1、创建项目

2、找到接口文档所在路径：一般是接口地址+ /v2/api-docs

如：https://xxxx.com/xxtest/v2/api-docs，打开的页面是swagger.json格式的页面

3、自动更新Swagger数据到YApi接口管理平台

>安装node.js，从Node.js官网下载安装包

>使用npm安装yapi-cli，执行指令：npm install yapi-cli [-g]

4、在yapi安装的任意目录下,新增配置文件:yapi-import.json


{
  "type": "swagger",
  "token": "17fba0027f300248b804",
  "file": "swagger.json",
  "merge": "good",
  "server": "http://yapi.local.qunar.com:3000"
}

其中：

type：是数据数据方式，目前官方只支持 swagger

token：是项目token，在 项目设置 -> token 设置获取

file：是 swagger 接口文档文件，可使用绝对路径或 url

merge：导入旧的接口策略，默认使用智能模式，一共有 "normal"(普通模式) , "good"(智能合并), "merge"(完全覆盖) 三种模式

server：是yapi服务器地址

5、在新建的配置文件当前目录下，执行：yapi import指令，把数据导入yapi接口管理平台（也可配合crontab执行工具进行自动更新接口数据）

十一、在YApi中运行脚本需按照chrome插件（目前只支持谷歌浏览器）

前往百度网盘地址下载： 链接: https://pan.baidu.com/s/102WqqNnrDawgCBq184daWQ 提取码: 6a43 下载完成后解压为crossRequest文件夹 2）打开浏览器扩展程序chrome://extensions/

3）打开浏览器扩展程序的开发者模式

4）单击【加载已解压的扩展程序】

5）安装成功如下

随机文章
本站知识点必读
最近更新