免费开源视觉化界面(API)管理平台——YAPI http://yapi.demo.qunar.com/ Github: https://github.com/YMFE/yapi nodejs(7.6+)mongodb(2.6+)git环境满足的话我们直接安装,安装方式很简单,官方提供了直接命令列方式部署,如果慢的话,请使用替换npm的国内映象 源代码安装npm install -g yapi-cli --国内映象 yapi server 启动后开启127.0.0.1:9000,如下图所示,对一些资讯进行填写配置,包括数据库的资讯 部署日志:背景
在之前有些时日,曾经写过一个API管理平台——DOClever,但是总觉得界面上稍微差了点,刚好之前有朋友在评论区留言,让我知道了今天要介绍的这个平台YAPI,YApi 是一个可本地部署的、打通前后端及QA的、视觉化的界面管理平台,由去哪儿网 YMFE 团队推出,在体验之后,感觉从各方面来说可能都要比DOClever要强上一些,因此也是要分享给大家的!官网和Github
官网:环境准备
因为我们在本地部署,那么本地也需要一些环境(环境安装不在介绍):
成功后根据提示到档案目录C:WindowsSystem32my-yapi,执行以下命令
node vendors/server/app.js
不出意外已经启动成功,然后我们开启127.0.0.1:3000,进入以下界面和官网一样
初始化管理员账号成功,账号名:[email protected]admin.com,密码:ymfe.org,我们使用它来登入,会出现一些指引,如下图所示
使用者管理
系统资讯
新建专案
专案建完之后,我在这测试了下界面,你可以对你的环境进行下配置,在测试界面请求之前你需要安装一下cross-request外挂,已经内建提供了zip压缩包,你可以下载离线安装Google外挂
环境配置
请求界面
查询动态
支援从其他地方汇入,入postman、swagger等
这只里面包含了很多专案
环境配置
请求配置
token配置
Mock
ts services
Swagger同步设定
特性介绍
YApi让界面开发更简单高效,让界面的管理更具可读性、可维护性,让团队协作更合理。基于 Json5 和 Mockjs 定义界面返回资料的结构和文件,效率提升多倍扁平化许可权设计,即保证了大型企业级专案的管理,又保证了易用性类似 postman 的界面除错自动化测试, 支援对 Response 断言MockServer 除支援普通的随机 mock 外,还增加了 Mock 期望功能,根据设定的请求过滤规则,返回期望资料支援 postman, har, swagger 资料汇入免费开源,内网部署,资讯再也不怕泄露了
扁平化管理
超级管理员(* N)- 建立分组- 分配组长
- 管理所有成员资讯
组长(* N)- 建立专案
- 管理分组或专案的资讯
- 管理开发者与成员
开发者(* N) / 成员(* N)- 不允许建立分组
- 不允许修改分组或专案资讯
界面管理的逻辑较为复杂,操作频率高,层层审批将严重拖慢生产效率,因此传统的金字塔管理模式并不适用。
YAPI 将扁平化管理模式的思想引入到产品的许可权管理中,超级管理员拥有最高的许可权,并将许可权分配给若干组长,超级管理员只需管理组长即可,实际上管理YAPI各大分组与专案的是“组长”。组长对分组或专案负责,一般由BU负责人/专案负责人担任。
界面文件
官方的界面文件我在本地测试无法访问,但是在Github源代码中找到了它,我们也可以静态部署到本地,非常的方便和人性化,如下图所示可通过开放的API对接平台,更方便管理和扩充套件