# YAPI-EX
**Repository Path**: lifedom/yapi-ex
## Basic Information
- **Project Name**: YAPI-EX
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-08
- **Last Updated**: 2025-09-08
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
### crazy-yapi分支补充功能说明：
### 分支部署说明
#### 环境要求
* nodejs（7.6+) 推荐v12.20.1
* mongodb（2.6+） https://docs.mongodb.com/manual/tutorial/install-mongodb-on-red-hat/
* git
* forever
* ykit
* chrome 开启跨域 设置教程见：http://crazy-yapi.camdy.cn/doc/documents/chromeCORS.html
#### crazy-yapi 未部署过yapi，初次部署
mkdir crazy-yapi
cd crazy-yapi
git clone --depth=1 https://gitlab.ws15.cn/yinyl/crazy-api.git vendors
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置（先在mongodb中创建好数据库和账户，根据实际值修改config.json）
cd vendors
npm install --registry https://registry.npm.taobao.org
ykit pack -m //用于修改代码后二次开发，大概60秒左右 编译过程中 如果显示 [Bundler] 1908/1912 build modules 不动了，按一下回车
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
forever start -o out.log -e err.log server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候
#### crazy-yapi 使用原有yapi数据库部署
mkdir crazy-yapi
cd crazy-yapi
git clone --depth=1 https://gitlab.ws15.cn/yinyl/crazy-api.git vendors
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置（先在mongodb中创建好数据库和账户，根据实际值修改config.json和原有yapi值一样）
cd vendors
npm install --production --registry https://registry.npm.taobao.org
node server/app.js 启动服务
#### 二次开发注意事项
若服务部署在外网使用需要升级Mongoose版本5.13.20以上，Mongoose 5.7.5版本存在Mongoose原型污染链导致的远程代码执行漏洞 https://github.com/YMFE/yapi/issues/2724
若服务部署在外网因为vm沙箱不安全，建议使用VM2升级至3.9.16或使用server/utils/sandbox.js替换sandbox(可能引起一些错误)
### 分支升级说明--举例
1. 停止服务：forever stopall
2. cd /opt/yapi/vendors/
3. 添加 分支仓库（**若已经添加，无需重复添加**） git remote add yehaoapi https://gitlab.ws15.cn/yinyl/crazy-api.git
4. 拉取新代码 git pull yehaoapi master
5. npm install --registry https://registry.npm.taobao.org
6. 打包 ykit pack -m
7. 启动服务 forever start -o out.log -e err.log server/app.js
## 特性功能演示：
### 接口多级目录：
### 用例多级目录：
### 用例导入示例参数
### 单用例前置后置js处理器（支持context storage）
### 包含子用例集
### test断言功能增强
### 失败中断测试：
### 循环测试：
### 禁用用例：
### 数据库断言，也可通过utils.axios请求mysql接口查询：
### sql查询：
### 二进制上传文件：
### 接口自动鉴权：
### 返回文件预览：
### 测试集合请求配置：
### 接口运行时长监听：
### 用例库关联接口用例，确保覆盖度，可exl导入：
### Swagger自定义导入：
### 找回密码：
### 测试集合负责人：
### web3连接metamask钱包签名：
### websocket连接测试：
### 用例参数批量同步：
### 统计：
### pb文件导入同步接口：
### 自动化测试计划：
### 自动化测试单用例循环：
### chai javascript断言：
### 请求超时判断：
### 谷歌登录：
### storage循环测试判断：
### firebase谷歌登录：
### 集成飞书机器人通知：
### 集成stripe支付：
### 服务器日志快捷查看：
### crazy-yapi 作者
* yyl 791482765@qq.com
---------------------以下内容为官方主分支说明文档------------------------------
## YApi 可视化接口管理平台
yapi.demo.qunar.com
### 平台介绍
YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
### 特性
* 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
* 扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
* 类似 postman 的接口调试
* 自动化测试, 支持对 Response 断言
* MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据
* 支持 postman, har, swagger 数据导入
* 免费开源，内网部署，信息再也不怕泄露了
### 内网部署
#### 环境要求
* nodejs（7.6+)
* mongodb（2.6+）
* git
#### 安装
使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码为 ymfe.org 登录系统（默认密码可在个人中心修改）。
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
#### 升级
升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。
cd {项目目录}
yapi ls //查看版本号列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本
### 教程
* [使用 YApi 管理 API 文档，测试， mock](https://juejin.im/post/5acc879f6fb9a028c42e8822)
* [自动更新 Swagger 接口数据到 YApi 平台](https://juejin.im/post/5af500e251882567096140dd)
* [自动化测试](https://juejin.im/post/5a388892f265da430e4f4681)
### YApi 插件
* [yapi sso 登录插件](https://github.com/YMFE/yapi-plugin-qsso)
* [yapi cas 登录插件](https://github.com/wsfe/yapi-plugin-cas) By wsfe
* [yapi gitlab集成插件](https://github.com/cyj0122/yapi-plugin-gitlab)
* [oauth2.0登录](https://github.com/xwxsee2014/yapi-plugin-oauth2)
* [rap平台数据导入](https://github.com/wxxcarl/yapi-plugin-import-rap)
* [dingding](https://github.com/zgs225/yapi-plugin-dding) 钉钉机器人推送插件
* [export-docx-data](https://github.com/inceptiongt/Yapi-plugin-export-docx-data) 数据导出docx文档
### 代码生成
* [yapi-to-typescript：根据 YApi 的接口定义生成 TypeScript 的请求函数](https://github.com/fjc0k/yapi-to-typescript)
* [yapi-gen-js-code: 根据 YApi 的接口定义生成 javascript 的请求函数](https://github.com/hellosean1025/yapi-gen-js-code)
### YApi docker部署（非官方）
* [使用 alpine 版 docker 镜像快速部署 yapi](https://www.jianshu.com/p/a97d2efb23c5)
* [docker-yapi](https://github.com/Ryan-Miao/docker-yapi)
### YApi 一些工具
* [mysql服务http工具,可配合做自动化测试](https://github.com/hellosean1025/http-mysql-server)
* [idea 一键上传接口到yapi插件](https://github.com/FurionCS/YapiIdeaUploadPlugin)
### License
Apache License 2.0