XXL-API 是一个强大易用的API管理平台,提供API的”管理”、”文档”、”Mock”和”测试”等功能。现已开放源代码,开箱即用。
主要特性:
- 极致简单:交互简洁,一分钟上手;
- 项目隔离:API以项目为维度进行拆分隔离;
- 分组管理:单个项目内的API支持自定义分组进行管理;
- 标记星级:支持标注API星级,标记后优先展示;
- API管理:创建、更新和删除API;
- API属性完善:支持设置丰富的API属性如:API状态、请求方法、请求URL、请求头部、请求参数、响应结果、响应结果格式、响应结果参数、API备注等等;
- markdown:支持为API添加markdown格式的备注信息;
- Mock:支持为API定义Mock数据并制定数据响应格式,从而快速提供Mock接口,加快开发进度;
- 在线测试:支持在线对API进行测试并保存测试数据,提供接口测试效率;
- 权限控制:支持以业务线为维度进行用户权限控制,分配权限才允许操作业务线下项目接口和数据类型,否则仅允许查看;
项目地址:
https://github.com/xuxueli/xxl-api
http://gitee.com/xuxueli0323/xxl-api
文档:https://www.xuxueli.com/xxl-api/
系统中API以项目为单位进行管理,因此首先需要管理项目;项目管理界面如下图所示;
API分组管理
API管理 如下图,在API接口管理界面,点击接口列表顶部的”新增接口”按钮,可进入新增接口界面;在新增接口界面,如下图所示,可以设置接口的API状态、请求方法、请求URL、请求头部、请求参数、响应结果、响应结果格式、响应结果参数、API备注等等信息;
API-Mock 在API接口管理界面,点击接口名称,进入”接口详情页”,在接口详情页的”Mock数据”模块右上角点击”+Mock数据”按钮,可新增Mock数据;
数据结构管理
END
公众号「测试开发技术」