YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

时间:2020-9-6 作者:admin

前言

作为一名前端开发,你在开发过程中,频繁书写mockjs感到困惑吗?Network不显示mockjs返回的数据感到忧愁吗?写了半天数据返回错误时一脸问号吗?加入蓝天计划吧,让你一夜暴富,成为第二个码云,第二个xxx,咳咳…

抱歉,刚才打错字了,作为一名前端开发工程师,曾经在项目开发过程中,都会有那么一段时间,用在书写mock数据上,下面这波操作,会让你甩开烦恼的本地mock,不用在本地创建js文件模拟数据,你没看错,就是这么骚气

本文章主要针对win10部署Yapi进行介绍,Linux出门左转,大致相同

API管理平台

市面上开源的接口管理平台,频频发布,下面来简单看一下

Yapi Esay-Mock eolinker Rap
文档管理 × ×
接口调试 × ×
自动化测试 × ×
插件安装 × × ×
开源
部署难度
  1. EsayMock:刚入行的时候用过,不过服务器总是爆炸,后来就没用了
  2. Yapi:我司目前采用的接口模拟管理方案

另外两款用的不多,不做太多评论了,

Yapi

YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,

开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

一、环境要求

  • nodejs(7.6+)
  • mongodb(2.6+)
  • git

二、安装Git

  1. Git官网下载:https://git-scm.com/downloads
  2. 直接下一步,下一步安装。

三、安装Node

  1. 官网下载:https://nodejs.org/en/download/
  2. 下一步下一步下一步安装
  3. 安装成功后,可查看node版本
node -v
或
node --version
  1. 查看npm版本
npm -v

四、安装MongoDB

  1. 下载MongoDB
  1. 选择Custom,一路next

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 下一步安装 “install mongoDB compass” 不勾选,否则可能要很长时间都一直在执行安装,MongoDB Compass 是一个图形界面管理工具,我们可以在后面自己到官网下载安装,下载地址:https://www.mongodb.com/downl…
  2. 配置MongoDB,进入MongoDB安装目录,进入bin文件夹,复制文件夹路径,打开控制面板,选择“系统与安全”——“系统”——“高级系统设置”,点击环境变量Path,将复制的路径新建在环境变量里面。
  • MongoDB的安装路径一般在:C:Program FilesMongoDBServer4.2bin

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 在安装目录下data创建一个db目录,作为安装目录data的备用目录,可以使用–dbpath””安装目录datadb”显式指定该目录为存储位置,来启动MongoDB,如:
1 cd C:\Program Files\MongoDB\Server\4.2
2 mongod.exe --dbpath "C:\Program Files\MongoDB\Server\4.2\data\db"
  1. 此时MongoDB已经开启,浏览器访问http://localhost:27017/,页面上会出现如下图所示。说明MongoDB已经启动了,且默认端口(27017)没有被占用。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

安装Yapi

  1. 前提安装好Node、Git、MongoDB
  2. 采用方式一:可视化部署[推荐]
  3. 在D盘下创建yapi空文件夹,利用git工具进行开启yapi服务。在文件夹空白处鼠标右击,会出现“Git Bash Here”,点击。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 安装yapi,命令如下所示。
1 npm install -g yapi-cli --registry https://registry.npm.taobao.org
2 yapi server
  1. 成功安装后,会出现如下截图。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 直接按照提示要求,打开网站http://localhost:9090/,填写公司名称。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 点击开始部署,部署完成并成功后,可通过底部提示启动服务器。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 我们回到Git Hash终端,最终底部也有相同的提示。如下图所示。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 直接输入“node vendors/server/app.js的命令,可看出有throw异常报错。报错如下图所示

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 打开创建项目的文件D:yapi,可发现文件夹下多出一个my-yapi的文件夹。在my-yapi下面才是YApi项目的文件。如下图所示。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

我们可得知,是我们运行的文件目录不对,应重新定位文件目录。我们需要定位目录至my-yapi文件夹。如下图所示。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

这样,我们就可以直接访问http://127.0.0.1:3000/。默认帐号:admin@admin.com,默认密码:ymfe.org。如下图所示。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

Yapi后台运行管理

  • 利用PM2管理YApi后台运行

PM2是node进程管理工具,可以利用它来简化很多node应用管理的繁琐任务,如性能监控、自动重启、负载均衡等,而且使用非常简单。

  1. 先全局安装PM2。打开CMD输入全局安装命令。如下所示。
npm install -g pm2

直接安装可看出经常安装失败。我们可利用国内镜像来安装,如下图所示

npm install -g pm2 --registry https://registry.npm.taobao.org

安装成功,如下图所示。

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

  1. 后台启动或关闭

我的YApi的安装目录在D:yapimy-yapi, 启动执行:

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

启动执行成功,如下所示

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

关闭执行:

pm2 stop D:\yapi\my-yapi\vendors\server\app.js

关闭执行成功,如下所示

YApi——手摸手,带你在Win10环境下安装YApi可视化接口管理平台

参考

  1. Yapi接口管理平台
  2. PM2实用入门指南
  3. MongoDB安装与配置

注:笔者最近发现了一款客户端接口管理工具,不过暂时不支持本地部署,笔者也只是在自己电脑上用一下,好用的话,以后会写文章详细介绍

声明:本文内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎进行举报,并提供相关证据,工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。