windows环境下yapi内网部署详细步骤

本文主要针对yapi进行介绍，以及如何在内网部署yapi，当然yapi也支持官网在线使用，根据自己的需求可以酌情选择。

• 什么是yapi？
• 为什么需要yapi？
• 如何在内网部署yapi？

一、什么是Yapi？

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

特性：

• 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
• 扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
• 类似 postman 的接口调试
• 自动化测试, 支持对 Response 断言
• MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据
• 支持 postman, har, swagger 数据导入
• 免费开源，内网部署，接口信息更安全

 

二、为什么需要Yapi？

业务痛点：后端程序员开发接口的同时还要编写接口对应的文档，这是一件繁琐且耗时的工程。前端工程师为了处理各种数据异常情况，将会写大量异常处理逻辑，同时对于前端程序员，在后端功能没有开发完成之前，他们需要接口返回数据 Mock ，以便不影响开发进度。传统的数据 mock 是把模拟数据写到项目代码里，这么做会带来更多新的问题，首先后端程序员定义的接口随着需求、架构涉及随时发生变化的，如果前端程序员完全按照最初的设计定义mock数据，将会和实际做出来的接口有很大的出入。

解决方案：

• YApi 将接口文档和测试通过单一数据源连接到一起，如果有改动，因为改的是单一的数据源，因此不会出现更新滞后和不及时问题。
• 在 YApi 中，后端既可以定义接口参数和返回值，也可以制定mock数据源，在后端开发过程中，可以随时调整接口定义，并通知给前端开发者改动信息，前后端只要维护接口定义的响应数据，就可以生成需要的模拟数据。
• YApi 提供了期望和自定义脚本的功能。
• YApi 提供 GUI 界面，只需配置相关的参数和断言语句，就能实现自动化测试，同时也提供了强大的 Pre-Script 和可视化表达式功能。
• YApi提供了灵活强大的插件机制满足各类业务的需求。目前YApi的第三方登录，swagger、postman 数据导入等功能都是基于插件机制实现。

 

三、如何在内网部署Yapi？

环境要求：

• nodejs（7.6+)
• mongodb（2.6+）

3.1 安装

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

3.2 运行

yapi server

运行成功后，在浏览器中访问以下地址：http://127.0.0.1:9090，在以下页面中填写项目相关信息

3.3 安装pm2来管理yapi服务

PM2（Process Manager 2 ）是具有内置负载均衡器的Node.js应用程序的生产运行时和进程管理器。 它允许您永久保持应用程序活跃，无需停机即可重新加载它们，并促进常见的Devops任务。

3.3.1 安装pm2

npm install pm2 -g

3.3.2 进入项目目录

cd /d E:\myyapi

3.3.3 利用pm2启动yapi服务（名称根据实际情况自定义）

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

备注常用的pm2命令：

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

按照以上步骤部署完成后，在浏览器中访问：http://127.0.0.1:3000/login，账号：上面3.2步骤中设置的管理员邮箱；默认密码：ymfe.org（默认密码可以在个人中心进行修改）

 

 至此，内网部署Yapi就已经完成了，yapi的使用比较简单，这里不做详细介绍，有兴趣的进去操作下就能快速上手。