快速将数据库SQL转换为RESTful API
suiw9 2025-04-05 22:27 5 浏览 0 评论
企业内部经常会开发一些小型系统或需要将现有的系统开发Restful API供内部系统集成,这类系统的特点是:几乎都是CRUD操作,业务简单,使用人数少,生命周期短。有没有一种工具,我们只需要关注数据库设计,使用它快速自动生成Restful API供前端或第三方系统调用?
本文将为大家介绍一个工具Hasura,它能够帮助你通过实时GraphQL API即时访问你的数据,因此你可以更快地构建和发布现代应用程序和API。Hasura连接到你的数据库、REST 服务器、GraphQL服务器和第三方API,为你的所有数据源提供统一的实时GraphQL API。
什么是Hasura
开源的SQL转API的项目不少,例如SQLer和Directus是Github Star数量较高的项目。Directus提供了用于管理SQL数据库内容的实时API和应用仪表板;SQLer是一个小型便携式服务器,使你可以使用SQL查询编写API,以便在任何人点击它时执行,它还使你能够定义验证规则,以便你可以验证请求正文/查询参数,以及使用简单的数据转换JavaScript语法。SQLer使用Nginx风格的配置语言(HCL)和JavaScript引擎来自定义表达式。
相比SQLer、Directus,Hasura提供了更为灵活、易用、强大的功能,同时它提供了Web Console,更便于管理API。Hasura提供以下功能:
- 强大的查询:内置过滤、分页、模式搜索、批量插入、更新、删除;
- 添加现有的数据库:将其指向现有数据库以立即获得即用型GraphQL API;
- 实时查询:使用订阅将任何GraphQL查询转换为实时查询;
- 操作扩展:编写REST API以使用自定义业务逻辑扩展Hasura的架构。
- 触发webhooks或无服务器功能:在Postgres插入/更新/删除事件;
- 预定触发器:使用cron配置或一次性事件在特定时间点执行自定义业务逻辑;
- 细粒度访问控制:与身份验证系统集成的动态访问控制;
- 管理UI:提供一个易用的Web管理UI;
- 多数据库支持:PostgreSQL、SQL Server、Big Query、MySQL等;
Hasura与GraphQL
GraphQL是一种数据语言,此语言的开发目的是便于应用程序从服务器上提取数据。它具有可指定的自记录风格。在GraphQL操作中,客户端指定数据从服务器返回时的结构如何。这样客户端就可以只查询它需要的数据,以它需要的格式进行查询。
GraphQL的实现分为Client和Server,Server实现了GraphQL协议,支持GraphQL查询,Client是一个GraphQL请求客户端,就像jQuery Ajax和Restful后端API的关系一样。GraphQL 有三项顶级操作:
- 查询 - 只读提取;
- 更改 - 写入,然后提取;
- 订阅 - 用于接收数据的长期活动连接;
GraphQL使应用程序开发人员可以轻松地从他们的API中精确查询他们想要的数据。例如,假设我们正在构建一个送餐应用程序。以下是Postgres上的表结构可能的样子:
对于显示当前用户订单的“订单状态”的应用程序,GraphQL查询将获取最新的订单状态和交付订单的位置,此查询参数作为字符串发送到网络服务器,该服务器对其进行解析、应用授权规则并适当调用数据库等内容以获取应用程序的数据。它以请求的确切格式将此数据作为JSON返回。
实时查询是能够订阅特定查询的最新结果。随着底层数据的变化,服务器应该将最新的结果推送给客户端。这与GraphQL完美契合,因为GraphQL客户端支持订阅来处理混乱的WebSocket连接。如果GraphQL服务器支持,将查询转换为实时查询非常简单。
Hasura本质上是一个GraphQL引擎,它也提供将GraphQL查询转换为Resrful API的功能。它拥有良好的并发实时订阅性能,并且支持垂直和/或水平扩展:
Hasura GraphQL引擎订阅实际上是实时查询,即订阅将返回正在进行的查询的最新结果,而不是导致结果的单个事件。Hasura通过将多个相似的订阅组合成一个SQL查询并从数据库中获取单个响应来优化订阅,而不是为每个订阅进行单独的SQL查询。
快速开始
下面我们开始使用Docker + Hasura + PostgreSQL演示一个CRUD的例子,具体看看Hasura能够提供的功能。首先我们使用Docker启动PostgreSQL数据库和Hasura Engine,并开启Console:
# PostgreSQL
docker run --name local-postgres \
-e POSTGRES_PASSWORD=your_password \
-e PGDATA=/var/lib/postgresql/data/pgdata \
-p 5432:5432 -d postgres:12
# Hasura
docker run -d -p 8080:8080 \
-e HASURA_GRAPHQL_DATABASE_URL=postgres://username:password@hostname:port/dbname \
-e HASURA_GRAPHQL_ENABLE_CONSOLE=true \
hasura/graphql-engine:latest
笔者使用Mac Book运行本案例,使用的docker.for.mac.localhost连接数据库,这是Docker内置的变量,代表本地hostname。如果你在实验过程中遇到PostgreSQL连接的问题,在Docker应用中连接Docker数据库可以通过inspect命令查看数据库在Docker中的端口和IP。
启动之后访问localhost:8080就可以看到Hasura的Console界面。这里我们直接使用这台PostgreSQL数据库,不再连接另外的Database。
安装PostgreSQL命令行客户端:
brew install libpq
brew link --force libpq
psql postgres://postgres:[your password]@localhost:5432/postgres
在PostgreSQL中创建一个Schema和两张表,一张是用户表,另一张是薪水表:
create schema if not exists example;
set search_path to 'example';
create sequence users_id_seq start 1000 increment 1;
create table users (
id integer primary key default nextval('users_id_seq'),
name varchar(40) NOT NULL,
gender integer NOT NULL,
cell_phone varchar(40) not null
);
create sequence payroll_id_seq start 1000 increment 1;
create table payroll (
id integer primary key default nextval('payroll_id_seq'),
user_id integer not null,
pay_day date not null,
salary money not null
);
在Console中添加这两张表:
插入一条用户数据:
mutation MyMutation($object: example_users_insert_input!) {
insert_example_users_one(object: $object) {
cell_phone
gender
name
}
}
// 参数
{
"object": {
"cell_phone": "18200008888",
"gender": 1,
"name": "Lisa"
}
}
查询数据库发现数据已经插入:
postgres=# select * from users;
id | name | gender | cell_phone
------+------+--------+-------------
1001 | Lisa | 1 | 18200008888
(1 row)
点击上图中的REST按钮将插入操作转换为Restful接口:
接着创建用户查询接口,在API Query窗口中添加User查询,生成的查询语句如下:
query MyQuery {
example_users {
cell_phone
gender
id
name
}
}
你同样可以点击“Analye”按钮查看Hasura生成的SQL语句:
点击REST按钮创建Restful API,至此我们创建了2个API:
通过浏览器访问API,效果如下:
删除、修改与订阅功能下文就不再演示了,你可以根据官方文档解锁Hasura更多的功能。通过本文的案例,相信你可以初步了解Hasura提供的能力,它是一个Graphql引擎,并能提供Restful接口,同时它能定时执行你定义的SQL,并在数据操作前允许你回调自定义接口以扩展功能。
通过向大家介绍Hasura为大家解决工作中的问题提供一个工具储备,相信能对你有所帮助。如果你在工作中也用到了Hasura,欢迎留言讨论。
参考资料
https://github.com/hasura/graphql-engine
https://hasura.io/docs/latest/graphql/core/index.html
相关推荐
- SpringBoot+MyBatis+Druid监控SQL的运行情况
-
今天想和大家聊一聊Druid中的监控功能。...
- JavaScript需要掌握的技能盘点(JS入门需看)
-
JavaScript是当今使用的最重要的Web开发语言之一。它使您可以为您的网站添加广泛的功能特性,从最基本得到最高级的。因此,无论您是专家级开发人员还是刚起步的初学者,您都需要了解某些关键的...
- 一款优秀的开源SQL检查审核神器,再也不用担心写SQL出问题了
-
写在前面今天要分享的这款工具是一个和SQL相关的开源神器,它可以在一定程度上解决运维和开发之间常见的痛点一环(相信可能有小伙伴也有所体会),对于开发和运维来说也算是一种福音。...
- 再一次重现sql注入,黑客技法详解
-
经过了我们前段时间的sql注入学习,今天我们来深入学习一下sql注入之cookie注入首先我们打开靶场环境随便点开一篇文章尝试在结尾构造一下and1=1可见是使用了防注入的,但是目前我们是使用ge...
- javascript实现获取中文汉字拼音首字母
-
今天分享一个日常开发中可能会用到的一个小功能,简单说就是输入中文汉字可转换得到中文汉字拼音首字母。当然我可写不出这样的功能,源码来自于其他民间大神的分享,博主在此记录一下功能demo,方便日后复用,同...
- 第三部分-第三章(第三节)常见的安全漏洞(SQL注入、XSS等)
-
常见的安全漏洞是指在应用程序或系统中由于设计、实现、配置等问题导致的安全漏洞。攻击者可以利用这些漏洞对系统进行恶意攻击、数据泄露、服务中断等行为。以下是一些常见的安全漏洞及其描述、影响和防护方法:1....
- Node.js 学习笔记:使用数据库(node.js 数据库访问)
-
这部分示例将示范SQLite3、MongoDB这两种不同类型的数据库在Node.js中的使用方法。首先,我们要在code目录下执行mkdir06_database命令来创建用于存放这一组示例的目...
- sql中常用的字符串函数详解(sql 字符串)
-
在日常开发中遇到处理最多的可能字符串要算其中一个了,什么替换啊截取啊大小写转换啊、删除空格啊等等,这些操作我们可以在前端操作,也可以直接在数据库的sql中操作,那么我们来看一下sql中处理字符串的...
- 如何防止数据库服务器的 SQL 注入攻击
-
如何防止数据库服务器的SQL注入攻击防止SQL注入攻击需要从代码开发、数据库配置到安全运维的全流程防护。以下是详细且可操作的防护策略和步骤:...
- JavaScript访问mysql,原来如此简单
-
你对JS的了解,是否还停留在jquery?来访问数据库试试吧,做全栈是如此的简单~!JS访问mysql的工具类,大致需求如下:1,单实例,避免数据库链接浪费。2,连接池功能。3,链接检测。4,提供简...
- 快速将数据库SQL转换为RESTful API
-
企业内部经常会开发一些小型系统或需要将现有的系统开发RestfulAPI供内部系统集成,这类系统的特点是:几乎都是CRUD操作,业务简单,使用人数少,生命周期短。有没有一种工具,我们只需要关注数据库...
- 基于 SQL + PHP 实现网页 “上一篇/下一篇” 功能的分步指南与优化方案
-
实现网页中的“上一篇”和“下一篇”功能,通常需要结合后端逻辑和前端展示。以下是分步说明及示例代码:一、实现思路数据库结构:文章/内容需要包含唯一标识(如id)和排序依据(如发布时间publish_...
- 国查:用中文编写SQL(sql在线查询)
-
这两天被文言(wenyan-lang)刷屏了,这个项目在于使用文言文进行编程,我打算蹭个热度,把年初的作品再捞一捞,即中文SQL。1.文言Wenyan:吾有一數。曰三。名之曰「甲」。...
- 全栈实战:React+Egg.js构建企业级JWT鉴权系统
-
技术栈组合:React19+Egg.js4.0+PostgreSQL16+Node.js22一、痛点场景:鉴权系统的复杂性...
- jeecg-boot学习总结及使用心得(jeecgboot技术文档)
-
jeecg-boot学习总结及使用心得1.jeecg-boot是一个真正前后端分离的模版项目,便于二次开发,使用的都是较流行的新技术,后端技术主要有spring-boot2.x、shiro、Myb...
你 发表评论:
欢迎- 一周热门
-
-
Linux:Ubuntu22.04上安装python3.11,简单易上手
-
宝马阿布达比分公司推出独特M4升级套件,整套升级约在20万
-
MATLAB中图片保存的五种方法(一)(matlab中保存图片命令)
-
别再傻傻搞不清楚Workstation Player和Workstation Pro的区别了
-
如何提取、修改、强刷A卡bios a卡刷bios工具
-
Linux上使用tinyproxy快速搭建HTTP/HTTPS代理器
-
Element Plus 的 Dialog 组件实现点击遮罩层不关闭对话框
-
MacOS + AList + 访达,让各种云盘挂载到本地(建议收藏)
-
日本组合“岚”将于2020年12月31日停止团体活动
-
SpringCloud OpenFeign 使用 okhttp 发送 HTTP 请求与 HTTP/2 探索
-
- 最近发表
- 标签列表
-
- dialog.js (57)
- importnew (44)
- windows93网页版 (44)
- yii2框架的优缺点 (45)
- tinyeditor (45)
- qt5.5 (60)
- windowsserver2016镜像下载 (52)
- okhttputils (51)
- android-gif-drawable (53)
- 时间轴插件 (56)
- docker systemd (65)
- slider.js (47)
- android webview缓存 (46)
- pagination.js (59)
- loadjs (62)
- openssl1.0.2 (48)
- velocity模板引擎 (48)
- pcre library (47)
- zabbix微信报警脚本 (63)
- jnetpcap (49)
- pdfrenderer (43)
- fastutil (48)
- uinavigationcontroller (53)
- bitbucket.org (44)
- python websocket-client (47)