YAPI简介

高效、易用、功能强大的API管理平台，为API开发者设计的管理平台

旨在为开发、产品、测试人员提供更优雅的接口管理服务。

YApi让接口开发更简单高效，让接口的管理更具可读性、可维护性，让团队协作更合理。




postgres SocketTimeout yml配置_开发者


功能列表

  • 项目管理

提供基本的项目分组，项目管理，接口管理功能

  • 接口管理

友好的接口文档，基于websocket的多人协作接口编辑功能和类postman测试工具，让多人协作成倍提升开发效率

  • MockServer

基于Mockjs，使用简单功能强大


postgres SocketTimeout yml配置_开发者_02


扁平化管理模式

接口管理的逻辑较为复杂，操作频率高，层层审批将严重拖慢生产效率，因此传统的金字塔管理模式并不适用。

YAPI 将扁平化管理模式的思想引入到产品的权限管理中，超级管理员拥有最高的权限，并将权限分配给若干组长，超级管理员只需管理组长即可，实际上管理YAPI各大分组与项目的是“组长”。组长对分组或项目负责，一般由BU负责人/项目负责人担任。

超级管理员(* N)

- 创建分组

- 分配组长

- 管理所有成员信息

组长(* N)

- 创建项目

- 管理分组或项目的信息

- 管理开发者与成员

开发者(* N) / 成员(* N)

- 不允许创建分组

- 不允许修改分组或项目信息

快速上手

  • 环境要求
  • 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.orgyapi server
  • 升级

升级项目版本是非常容易的，并且不会影响已有的项目数据，只会同步 vendors 目录下的源码文件。

cd {项目目录}yapi ls //查看版本号列表yapi update //更新到最新版本yapi update -v {Version} //更新到指定版本