(19)国家知识产权局 (12)发明 专利申请 (10)申请公布号 (43)申请公布日 (21)申请 号 202211017197.0 (22)申请日 2022.08.24 (71)申请人 南威软件股份有限公司 地址 362018 福建省泉州市丰泽区丰海路 南威大厦2号楼 (72)发明人 吴志雄　陈泽辉　 (74)专利代理 机构 福州元创专利商标代理有限 公司 35100 专利代理师 丘鸿超　蔡学俊 (51)Int.Cl. G06F 8/34(2018.01) G06F 16/25(2019.01) G06F 16/242(2019.01) G06F 16/2455(2019.01) G06F 21/57(2013.01)G06F 8/71(2018.01) (54)发明名称 基于动态SQ L配置生成API接口 的方法 (57)摘要 本发明提出一种基于动态SQL配置生成API 接口的方法， 提供接口配置系统， 提供可视化的 接口配置功能； 可用于针对不同场景下， 自动根 据已有的SQL语句对外提供服务接口， 开发或运 维人员可通过可视化的界面的sql语句编写及相 关参数的配置， 直接生成对应的API服务接口， 供 前端系统调用或者对外提供数据服务。 免去了给 后端开发人员提接口开发需求、 沟通业务逻辑、 排期开发、 代码编写、 打包、 部署、 发布等一系列 冗长等过程； 同时可对于需求的变更可及时修改 已有的SQL逻辑和配置项,达到快速相应需求变 更的要求， 在一定程度上大大减少了系统的开发 和维护成本 。 权利要求书1页 说明书4页 附图1页 CN 115309387 A 2022.11.08 CN 115309387 A 1.一种基于动态SQL配置生成API接口的方法， 其特征在于， 基于带有可视化的接口配 置功能的接口配置系统， 包括以下步骤： 步骤S1： 通过可视化接口配置页面， 编写包括： SQL的查询语句、 接口参数、 配置接口地 址、 调用协议、 调用方式、 返回结果方式的信息， 提交配置系统后台进行审核； 步骤S2： 审核完成后， 接口配置系统通过已配置的信息解析SQL语句、 配置参数， 基于 jdk动态代理的方式， 自动生成一个可执行程序类方法， 并根据不同的协议要求， 生成对应 访问路径的API接口服 务供前端或下游系统调用； 步骤S3： 接收调用方的调用请求， 解析接口地址和调用参数， 调用相关的业务方法； 同 时对调用参数进行合法性和安全性校验， 以避免系统安全漏洞； 步骤S4： 根据配置信息和业务要求拼接对应的SQL拼接和SQL参数的拼装， 并通过执行 器执行对应的SQ L语句得出结果； 步骤S5： 按配置要求对SQ L执行接口结果对象进行包 装处理， 并返回给接口调用方。 2.根据权利 要求1所述的基于动态SQL配置生成API接口的方法， 其特征在于： 在步骤S2 中， 生成可执行程序类方法具体为， 对SQL语句和配置信息进行解析， 使用工程模式构造 Mapper的可执行方法。 3.根据权利 要求2所述的基于动态SQL配置生成API接口的方法， 其特征在于： 所述接口 配置系统预设mapper模板并通过已编写的SQL语句和配置信息， 自动生成可执行的java类 方法； 利用java后台的JDK动态 代理， 将生成的类方法与接口控制器进行绑定 。 4.根据权利 要求1所述的基于动态SQL配置生成API接口的方法， 其特征在于： 在步骤S3 中， 对写入参数的安全性校验具体为： 针对SQL语句可能出现的SQL注入、 数据敏感词的检 查， 并对拼接后的可执行SQL语句进行二次校验； 对于校验不通过的请求接口， 自动进行错 误返回并返回给调用方调用失败信息 。 5.根据权利 要求1所述的基于动态SQL配置生成API接口的方法， 其特征在于： 在步骤S3 中， 生成的API接口提供REST、 RPC支持多种协议调用,并支持GET、 POST调用方式配置； 生成 的API接口支持动态的请求参数， 基于参入的参数动态 生成SQL语句， 将拼接后的SQL传 入数 据库执行器进行 执行并返回结果。 6.根据权利 要求1所述的基于动态SQL配置生成API接口的方法， 其特征在于： 在步骤S4 和步骤S5中， 基于模板方法模式， 对接口返回信息的自动分类处理， 包括对返回结果的分 页、 发片、 缓存和静态数据切换。权　利　要　求　书 1/1 页 2 CN 115309387 A 2基于动态SQL配置生成 API接口的方 法 技术领域 [0001]本发明涉及计算机技术领域， 尤其涉及一种基于动态SQL配置生成API接口的方 法。 背景技术 [0002]在软件系统开发过程中， AP I服务接口开发是最常见开发工作之一。 前后端之间的 数据交互、 各微服务模块之间的数据传输， 都需要依赖于API接口之间的通讯和数据交互； 因此， API数据接口开发效率可以很大程度上影响了软件系统的开发交付效率。 [0003]在传统的业务系统开发中， 一个API接 口的完成往往需要经历一个冗长的软件开 发过程， 如需求的设计、 评审、 编码开发、 测试、 部署、 发布等， 特别是在后期的优化迭代阶 段， 不像前期大量需求的集中开发， 它是一个程序迭代增加的过程； 如果每个API接口需求 都要等待冗 长的开发过程， 这将影响需求响应速度和开发成本效率的增 加。 发明内容 [0004]为了解决现有技术存在的缺陷和不足的问题， 本发明提出一种基于动态SQL配置 生成API接口的方法。 以解决通用场景下， 依据SQL语句快速生成API接口并方法， 以打包低 代码或零代码的开发要求， 一定程度上提高系统开发效率。 [0005]基于提供的接口配置系统， 提供可视化的接口配置功能； 可用于针对不同场景下， 自动根据已有的SQL语句对外提供服务接口， 开 发或运维人员可通过可视化的界面的sql语 句编写及相关参数的配置， 直接生成对应的API服务接口， 供前端系统调用或者对外提供数 据服务。 免去了给后端开发人员提接口开发需求、 沟通业务逻辑、 排期开发、 代码编写、 打 包、 部署、 发布等一系列冗长等过程； 同时可对于需求的变更可及时修改已有的SQL逻辑和 配置项,达 到快速相应需求变更的要求， 在一定程度上 大大减少了系统的开发和维护成本 。 [0006]为了达到上述目的， 本发明具体采用如下技 术方案： 一种基于动态SQL配置生成API接口的方法， 其特征在于， 基于带有可视化的接口 配置功能的接口配置系统， 包括以下步骤： 步骤S1： 通过可视化接口配置页面， 编写包括： SQL的查询语句、 接口参数、 配置接 口地址、 调用协议、 调用方式、 返回结果方式的信息， 提交配置系统后台进行审核； 步骤S2： 审核完 成后， 接口配置系统通过已配置的信息解析S QL语句、 配置参数， 基 于jdk动态代理的方式， 自动生成一个可执行程序类方法， 并根据不同的协议要求， 生成对 应访问路径的API接口服 务供前端或下游系统调用； 步骤S3： 接收调用方的调用请求， 解析接口地址和调用 参数， 调用相关的业务方 法； 同时对调用参数进行合法性和安全性校验， 以避免系统安全漏洞； 步骤S4： 根据配置信息和业务要求拼接对应的SQL拼接和SQL参数的拼装， 并通过 执行器执行对应的SQ L语句得出结果； 步骤S5： 按配置要求对SQL执行接口结果对象进行包装处理， 并返回给接口调用说　明　书 1/4 页 3 CN 115309387 A 3