zhangdongjia/yapi

crazy-yapi分支补充功能说明：

接口定义中参数示例参数如果是json格式，则会进行染色并格式化
增加接口/用例空间内跨项目移动功能
全局搜索增加支持接口路劲搜索（不包含basepath）
修复form参数批量导入时，示例值中包含冒号，导入后冒号后面内容丢失的bug
优化查询参数示例显示宽度为自适应
增加接口状态（从原来的未完成-已完成改为：设计中，开发中，已提测，已发布，已过时，暂停开发）
增加用例前置/后置脚本处理器，兼容context、storage，执行顺序：项目请求前置脚本-》用例前置脚本-》用例后置脚本-》项目响应处理脚本
在F12-console控制台打印用例执行的context内容，减小对cross控制台查看请求参数的依赖
在控制台打印请求配置脚本以及前置后置js脚本的异常错误，提高调试效率

当前分支用户（使用当前分支的请提交issure，用的人越多功能支持更新越快）

小影

分支部署说明

前置条件：先参考主分支部署说明部署主分支，停止yapi服务后，再进行以下操作

安装forerver（使用forerver 后台运行nodejs）,安装 ykit
cd xxxx/yapi/vendors
添加分支仓库（若已经添加，无需重复添加） git remote add yehaoapi https://github.com/xian-crazy/yapi.git
删除本地文件rm -rf *
获取全部代码：git reset --hard yehaoapi/master
安装依赖 npm install --registry https://registry.npm.taobao.org
前端打包 ykit pack -m
启动服务 forever start -o out.log -e err.log server/app.js

分支升级说明

停止服务：forever stopall
cd xxx/yapi/vendors/
拉取新代码 git pull yehaoapi master
打包 ykit pack -m
启动服务 forever start -o out.log -e err.log server/app.js

crazy-yapi 分支作者

crazy 330126160@qq.com

---------------------以下类容为主分支说明文档------------------------------

YApi 可视化接口管理平台

yapi.demo.qunar.com

平台介绍

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

QQ交流群: 644642474

特性

基于 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 插件

代码生成

YApi docker部署（非官方）

YApi 一些工具

YApi 主分支的一些客户

去哪儿
携程
艺龙
美团
百度
腾讯
阿里巴巴
京东
今日头条
唯品支付
链家网
快手
便利蜂
中商惠民
新浪
VIPKID

主分支 Authors

License

Apache License 2.0

About

YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台

http://yapi.demo.qunar.com/