- 💂 个人网站:IT知识小屋
- 🤟 版权:本文由【IT学习日记】原创、在CSDN首发、需要转载请联系博主
- 💬 如果文章对你有帮助、欢迎关注、点赞、收藏(一键三连)和订阅专栏哦
文章目录
- 简介
- 特点
- 功能列表
- 快速部署
- 开源地址&使用手册
- 写在最后
简介
说起xxx-job相信大家肯定不陌生，作为一款分布式任务调度平台，在开源社区广受欢迎，github已经获得累计30k star，上千家中大型企业在生产环境运行。xxl-api是作者继xxl-job后又一重大开源。
XXL-API是一款专为开发者、团队与组织的设计的API管理平台，旨在统一API接口的管理、文档生成、Mock服务、在线测试等核心环节，帮助团队从设计、开发、测试到运维的整个API生命周期集中管理与协同。系统源码100%开源、上手简单，十分适用于中小型企业快速打造内部或对外的API平台。
系统支持多项目隔离、权限控制、接口分组管理、接口星级标注、Markdown描述、Mock数据生成、在线测试等功能，覆盖常见的API管理全生命周期流程。用户可在内部私有部署，也可作为公共服务使用。采用前后端分离架构设计，后端基于Java技术栈，前端界面简洁直观，便于二次扩展与定制开发，能够满足中小型企业API管理与协作99%的使用场景。
特点
易学易用：功能实用、交互简洁，三分钟上手。
容器化：提供官方 docker 镜像，并实时更新推送 dockerhub，进一步实现产品开箱即用。
项目隔离：支持以项目维度进行 API 隔离管控。
分组管理：针对单个项目中 API，支持自定义分组进行管理。
权限控制：支持以业务线为维度进行用户权限控制，分配权限才允许操作业务线下项目接口和数据类型，保障 API 数据安全。
API Mock：内置 MockServer，支持为 API 灵活定义 Mock 数据并定制数据响应格式，从而快速提供 Mock 接口、加快开发进度。
API 测试：支持针对 API 进行在线测试，且支持定义管理测试数据，提升接口测试效率。
API 管理：支持创建、更新和删除 API。
属性丰富：支持丰富的 API 属性设置，包括 API 状态、请求方法、请求 URL、请求头部、请求参数、响应结果、响应结果格式、响应结果参数、API 备注等。
星级标记：支持 API 星级标注，标记后优先提权展示。
Markdown：支持为 API 添加 Markdown 格式的备注信息。
功能列表
项目管理：系统中API以项目为单位进行管理，因此首先需要管理项目；项目管理界面如下图所示
新建项目:进入项目管理界面，点击右侧”+新增项目”按钮可新建项目，如下图所示：
项目属性说明： 业务线：所属业务线 项目名称：项目的名称； 项目描述：项目的描述信息； 根地址(线上)：项目线上环境根地址，项目中的API共用该根地址； 根地址(预发布)：项目预发布环境根地址； 根地址(测试)：项目测试环境根地址；API管理：在项目管理界面，点击项目右侧的”进入项目”按钮，可进入接口管理界面：
新增API：在新增接口界面，如下图所示，可以设置接口的API状态、请求方法、请求URL、请求头部、请求参数、响应结果、响应结果格式、响应结果参数、API备注等等信息
API-Mock：在API接口管理界面，点击接口名称，进入”接口详情页”，在接口详情页的”Mock数据”模块右上角点击”+Mock数据”按钮，可新增Mock数据
API-测试：进入”接口详情页”，点击”Test历史”模块右上角的”+接口测试”按钮，可进入”接口测试界面”，该界面将会自动初始化接口URL（测试界面支持选择运行环境，将会自动生成不同环境的完整URL连接）和参数等信息
数据结构管理：支持维护格式化的数据结构，更加直观方便的查看数据信息。接口响应数据支持绑定数据结构，从而更加直观查看接口的响应数据的格式化信息。数据结构属性支持嵌套引用，也支持被复用
用户管理：管理员：拥有系统所有权限。普通用户：默认只拥有项目接口和数据类型的只读权限，被分配业务线权限后，才允许操作业务线下项目和接口等。
业务线管理：
分类管理：项目接口归属于业务线下，可通过业务线隔离不同的项目接口，方便管理
-权限控制：系统以业务线为维度进行权限控制，用户只有拥有业务线权限，才允许操作业务线下项目接口，否则只允许查看
快速部署
- 环境：
Maven：3.9+ Jdk：17+ Mysql：8.0+- 初始化“API数据库”：请下载项目源码并解压，获取 “初始化SQL脚本”，脚本位置如下
/xxl-api/doc/db/tables_xxl_api.sql- 编译源码：解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可，源码结构如下：
- xxl-api - xxl-api-admin ：API管理中心项目- 配置JDBC连接：在以下项目文件中设置应用的JDBC连接
/xxl-api/xxl-api-admin/src/main/resources/application.properties- 部署：
部署运行 “xxl-api-admin” 后，即可访问 默认登录账号 “admin/123456”- 集群(可选)
API管理中心支持集群部署，提升系统可用性 集群部署时，保持各项目JDBC配置一致即可开源地址&使用手册
点击下方的【IT学习日记】回复【资源】领取！
如果这篇文章对您有帮助，请一定帮我点个“关注”和“点赞”,这对我非常重要。我将会继续推荐更多优质项目和新闻。
写在最后
1000+优质开源项目更新进度：232/1000。如需更多类型优质项目推荐，请在文章后留言。
