YApi
YAPI是一个开源的API管理平台，用于帮助团队管理和维护API。它提供了文档编写、接口测试、版本控制和部署等功能，并且支持各种类型的API，包括RESTful API和WebSocket API等。
使用YAPI可以大大提高团队的工作效率，方便开发者和用户查看和测试API接口。
特性
- 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
- 扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
- 类似 postman 的接口调试
- 自动化测试, 支持对 Response 断言
- MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据
- 支持 postman, har, swagger, json 数据导入
- 免费开源，内网部署，信息再也不怕泄露了
使用方法
权限
- 超级管理员：拥有最高的权限，并将权限分配给若干 组长，超级管理员 只需管理组长 即可；
- 组长：实际上管理YAPI各大分组与项目的是“组长”。组长对分组或项目负责；
- 分组组长：权限包括修改分组、删除分组、创建分组下的项目。一般来说，分组组长 只需要对项目负责，将项目的操作任务安排给 项目组长 处理即可。
- 项目组长：只属于某一个项目因此它无法操作项目所属分组，但拥有项目的全部权限，项目组长 是 YApi 的基层管理者，承担了 YApi 绝大部分的日常管理工作。
- 项目开发者：指定项目中的开发人员，对项目接口进行增删改查。
- 游客：新用户未加入项目或分组时，我们称为 “访客”。
项目权限
| 操作 | 游客 | 项目开发者 | 项目组长 | 超级管理员 |
|---|---|---|---|---|
| 浏览公开项目与接口 | ✓ | ✓ | ✓ | ✓ |
| 浏览私有项目与接口 | - | ✓ | ✓ | ✓ |
| 编辑项目信息 | - | ✓ | ✓ | ✓ |
| 新建接口 | - | ✓ | ✓ | ✓ |
| 编辑接口 | - | ✓ | ✓ | ✓ |
| 编辑项目头像 | - | - | ✓ | ✓ |
| 删除项目 | - | - | ✓ | ✓ |
分组权限
| 操作 | 游客 | 项目开发者 | 项目组长 | 超级管理员 |
|---|---|---|---|---|
| 浏览分组 | ✓ | ✓ | ✓ | ✓ |
| 在分组中新建项目 | - | ✓ | ✓ | ✓ |
| 编辑分组信息 | - | - | ✓ | ✓ |
| 管理分组成员 | - | - | ✓ | ✓ |
| 删除分组 | - | - | ✓ | ✓ |
创建分组
每个人都有一个默认私有分组“个人空间”
只有 超级管理员 有权限创建分组
新建分组中分别包含以下选项
- 项目列表：组内相关的项目维护；
- 成员列表：组内成员维护管理；
- 分组动态：记录对分组的相关操作日志；
- 分组设置：分组基本设置；
创建项目
- 进入管理员账号并使用添加项目功能
- 添加项目并设置访问权限和所属分类
添加接口
- 进入项目并使用添加接口功能
- 输入接口信息，包括接口名称、请求方式、请求参数、返回参数等
- 保存接口
编辑接口
- 进入项目并打开需要编辑的接口
- 修改接口信息
- 保存接口
接口测试
- 进入项目并打开需要测试的接口
- 在页面中输入请求参数，点击发送请求
- 在页面中查看响应结果
发布接口
- 进入项目并打开需要发布的接口
- 将接口状态更改为发布状态
总结
使用YAPI可以使API管理变得更加简单和高效。它提供了文档编写、接口测试、版本控制和部署等功能，并支持各种类型的API。如果您的团队需要一个API管理平台，不妨考虑使用YAPI。