SQLREST助开发者高效构建RESTful API，动态SQL与Groovy脚本灵活应对复杂场景，内置Token安全认证及Swagger文档生成，通过Sentinel实现流量控制，全面支持Oracle、MySQL等30+主流数据库，开源架构涵盖开发、测试、部署全流程，助力API开发效率提升50%。

1. SQLREST工具简介

SQLREST工具——RESTful接口构建的得力助手。这个工具旨在帮助开发者高效地构建和部署RESTful API，特别是在需要频繁调用数据库的情况下，提供了极大的便利。

1.1 项目概述和目标

SQLREST，一个助力高效构建RESTful接口的开源工具，为开发者提供了便捷的方式。通过SQLREST，用户能够轻松地定义、测试和部署RESTful API，从而提升开发效率。

1.2 开源协议说明

目前，SQLREST项目代码完全开源，没有任何保留与混淆操作。

2. 功能概览和架构

2.1 核心功能介绍

SQLREST工具不仅提供快速构建RESTful API接口的便捷方式，还支持多种功能，包括SQL方式和Groovy脚本方式构建接口。具体来说，它提供了类似mybatis的动态SQL语法，使得接口构建更为灵活多样。同时，基于groovy脚本的语法方式，该工具能轻松应对复杂场景下的接口构建需求。此外，sqlrest还内置了token安全认证功能，确保接口的安全性。在HTTP入参方面，它支持
application/x-www-form-urlencoded及application/json等多种请求格式。更为强大的是，它还能基于swagger-ui生成在线接口文档，方便团队协作与文档管理。此外，执行器基于sentinel，提供了流量控制功能，有效保障系统的稳定运行。

2.2 数据库支持类型

甲骨文的Oracle数据库，微软的Microsoft SQLServer，以及MySQL、MariaDB、PostgreSQL等主流数据库均受到sqlrest工具的支持。同时，对于Greenplum（需使用PostgreSQL类型）、IBM的DB2、Sybase数据库，以及国产的达梦数据库DM、人大金仓数据库Kingbase8、翰高数据库HighGo、神通数据库Oscar、南大通用数据库GBase8a等，sqlrest同样提供了良好的支持。此外，Apache Hive、SQLite3、OpenGauss、ClickHouse、Apache Doris、StarRocks以及OceanBase等数据库也都被纳入其支持范围之内。

2.3 模块结构功能

sqlrest框架由多个模块组成，包括sqlrest-common（通用定义模块）、sqlrest-template（SQL内容模板模块）、sqlrest-cache（执行器缓存模块）、sqlrest-persistence（数据库持久化模块）、sqlrest-core（接口实现模块）、sqlrest-gateway（网关节点）、sqlrest-executor（接口执行节点）、sqlrest-manager（管理节点）以及sqlrest-manager-ui（基于Vue2的管理前端WEB交互页面）。此外，还包括sqlrest-dist模块，它基于maven-assembly-plugin插件，负责项目的打包工作。

2.4 未来规划

(1) 接口响应输出参数列表及详细说明文档
通过手动配置或接口调试，来生成接口输出参数的详细说明文档。

(2) 接口缓存配置支持
利用分布式缓存等技术，为接口提供缓存配置支持。

(3) SQL查询结果集与接口输出参数格式的转换
实现SQL查询结果集到接口输出参数所需格式的自动转换。

(4) 前端界面全面美化
提升用户界面的交互体验和视觉美感。

3. 技术选型与编译打包

3.1 技术基础与环境要求

本工具完全采用Java语言进行开发，且所有依赖均来自开源项目，确保了技术的成熟性与稳定性。

3.2 编译和打包流程

环境需求：

• JDK：版本需达到1.8或以上（推荐使用JDK 1.8）
• maven：版本需达到3.6或以上

注意：由于Maven仓库默认位于国外，国内用户使用时可能会遇到速度慢的问题。为此，可以选用阿里云提供的Maven仓库来加速下载。

编译步骤：
(1) 在Windows系统中，双击build.cmd脚本文件即可开始编译打包。
(2) 若在Linux环境下，首先通过git clone sqlrest命令克隆项目，然后进入项目目录，执行sh ./build.sh命令进行编译打包。
(3) 使用Docker进行编译时，同样先克隆项目，进入项目目录后，执行sh ./docker-maven-build.sh命令进行编译打包。

请详细查阅README.md文档，其中包含了对安装部署的详细说明。最后附上地址吧。

项目地址：
https://gitee.com/inrgihc/sqlrest