①、必传参数
参数格式为:{!param=#paramValue#}
SELECT * FROM employee e WHERE {! e.username = #username# }首页 > 数据库 > 数据库开发技术 > 基于南瓜树数智平台在线开发API服务
文中有视频教程
一、引言

通过SQL开发API具有多个好处,这些好处涵盖了开发效率、可维护性、安全性和灵活性等方面。以下是通过SQL开发API的一些主要好处:
数据访问抽象化:
SQL API为开发者提供了一种抽象化的数据访问方式,隐藏了底层数据库的复杂性和细节。这使得开发者可以更加专注于实现业务逻辑,而无需过多关注数据库的具体操作。
提高开发效率:
SQL API通常提供丰富的函数和方法来执行常见的数据库操作,如查询、插入、更新和删除等。这些预定义的函数可以大大减少开发者编写和维护数据库操作代码的工作量,从而提高开发效率。
增强数据安全性:
通过SQL API,开发者可以利用参数化查询或预处理语句来执行数据库操作,这有助于防止SQL注入等安全问题。此外,API还可以提供加密、身份验证和访问控制等机制,进一步保护数据的安全性。
易于维护和扩展:
将数据库操作封装在API中,使得代码更加模块化、结构化和可重用。这不仅简化了代码的维护过程,还使得在需要时扩展或修改数据库操作变得更加容易。
提供数据完整性保障:
SQL API可以包含对数据完整性的检查和处理逻辑,如事务管理、数据验证等。这有助于确保存储在数据库中的数据是准确、一致和可靠的。
促进团队协作:
当数据库操作被封装在API中时,不同的开发团队可以更容易地协作。前端团队只需调用相应的API接口,而无需了解底层数据库的详细信息。这种分离使得团队之间的工作更加独立和高效。
支持复杂查询和操作:
SQL语言本身支持复杂的查询和操作,如连接、子查询、聚合函数等。通过SQL API,开发者可以轻松地构建和执行这些复杂查询,从而满足复杂的业务需求。
二、如何基于南瓜树数智平台开发API服务
基于南瓜树数智化平台提供的八大服务能力来编写SQL快速开发API服务、跨库事务控制服务、联邦查询服务。提高开发效率、增强数据安全性、简化代码维护、促进团队协作,并支持复杂的数据库操作。
使用视频教程:
三、使用规则:
①、必传参数
参数格式为:{!param=#paramValue#}
SELECT * FROM employee e WHERE {! e.username = #username# }②、非必传参数
参数格式为:{? param=#paramValue#}
SELECT * FROM employee e WHERE 1=1 {? and e.username = #username# }③、用户环境变量参数
变量参数:@Env(loginId)
SELECT * FROM employee e WHERE 1=1 {? and e.username = @Env(loginId) }④、日期内置变量
变量参数:
@{yyyy} 当前年份 2024
@{MM} 当前月份 04、10
@{dd} 当前日期天 20
@{yyyy-MM-dd} 当前年月日,例如:2024-01-21
@{yyyy-MM-dd HH:mm:ss} 当前年月日时分秒:2024-01-21 18:12:12
四、八大服务
1、登录服务
接口:
http://localhost:8087/prod-api/datasource/login测试实例数据:
{"username":"admin","password":"yabushan"}
2、新增服务
接口:
http://localhost:8087/prod-api/datasource/insert测试实例数据:
{"USER_NAME":"我是XXX111","USER_MEMO":"我来之中111国","ApiCode":"NGS_INSERT_TEMP_TEST_API"}
3、修改服务
接口:
http://localhost:8087/prod-api/datasource/update测试实例数据:
{"USER_NAME":"李斯","APPROE_STATUS":"777","id":"2","ApiCode":"NGS_UPDATE_TEMP_TEST_API"}
4、删除服务
接口:
http://localhost:8087/prod-api/datasource/delete测试实例数据:
{"id":"2","ApiCode":"NGS_DELETE_TEMP_TEST_API"}
5、查询服务
接口:
http://localhost:8087/prod-api/datasource/select测试实例数据:
{"ApiCode":"NGS_QUERY_TEMP_TEST_API"}
6、分页查询服务
接口:
http://localhost:8087/prod-api/datasource/pageSelect测试实例数据:
{"pageNum":2,"pageSize":10,"ApiCode":"NGS_QUERY_TEMP_TEST_API"}
7、联邦查询服务
接口:
http://localhost:8087/prod-api/datasource/unionSelect测试实例数据:
[{"apiCode": "NGS_QUERY_TEMP_TEST_API","params": {"id":"1"},"sort": 1},{"apiCode": "NGS_QUERY_TEMP_TEST_API1","params": {"id":"1"},"sort": 2}]
8、联邦事务控制服务
接口:
http://localhost:8087/prod-api/datasource/transaction测试实例数据:
[{"apiCode": "NGS_INSERT_TEMP_TEST_API","params": {"USER_MEMO":"测试联邦新增事务失败的"},"sort": 5},{"apiCode": "NGS_DELETE_TEMP_TEST_API","params": {"id":"12"},"sort": 3}]
基于南瓜树数智化平台通过SQL快速开发API服务、跨库事务控制服务、联邦查询服务。提高开发效率、增强数据安全性、简化代码维护、促进团队协作,并支持复杂的数据库操作。
更多教程:
【南瓜树基础能力平台白皮书】https://note.youdao.com/s/KMle9FLi
原文作者:小南瓜开发平台;如有侵权,请联系管理员删除。