个人网站: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连接和参数等信息数据结构管理支持维护格式化的数据结构更加直观方便的查看数据信息。接口响应数据支持绑定数据结构从而更加直观查看接口的响应数据的格式化信息。数据结构属性支持嵌套引用也支持被复用用户管理管理员拥有系统所有权限。普通用户默认只拥有项目接口和数据类型的只读权限被分配业务线权限后才允许操作业务线下项目和接口等。业务线管理分类管理项目接口归属于业务线下可通过业务线隔离不同的项目接口方便管理-权限控制系统以业务线为维度进行权限控制用户只有拥有业务线权限才允许操作业务线下项目接口否则只允许查看快速部署环境Maven3.9 Jdk17 Mysql8.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。如需更多类型优质项目推荐请在文章后留言。