快速将数据库SQL转换为RESTful API
liuian 2024-12-07 14:57 45 浏览
企业内部经常会开发一些小型系统或需要将现有的系统开发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
- 上一篇:PostgreSQL 数据类型
- 下一篇:良心免费sql工具推荐!
相关推荐
- 搭建一个20人的办公网络(适用于20多人的小型办公网络环境)
-
楼主有5台机上网,则需要一个8口路由器,组网方法如下:设备:1、8口路由器一台,其中8口为LAN(局域网)端口,一个WAN(广域网)端口,价格100--400元2、网线N米,这个你自己会看了:)...
- 笔记本电脑各种参数介绍(笔记本电脑各项参数新手普及知识)
-
1、CPU:这个主要取决于频率和二级缓存,频率越高、二级缓存越大,速度越快,现在的CPU有三级缓存、四级缓存等,都影响相应速度。2、内存:内存的存取速度取决于接口、颗粒数量多少与储存大小,一般来说,内...
- 汉字上面带拼音输入法下载(字上面带拼音的输入法是哪个)
-
使用手机上的拼音输入法打成汉字的方法如下:1.打开手机上的拼音输入法,在输入框中输入汉字的拼音,例如“nihao”。2.根据输入法提示的候选词,选择正确的汉字。例如,如果输入“nihao”,输...
- xpsp3安装版系统下载(windowsxpsp3安装教程)
-
xpsp3纯净版在采用微软封装部署技术的基础上,结合作者的实际工作经验,融合了许多实用的功能。它通过一键分区、一键装系统、自动装驱动、一键设定分辨率,一键填IP,一键Ghost备份(恢复)等一系列...
- 没有备份的手机数据怎么恢复
-
手机没有备份恢复数据方法如下1、使用数据线将手机与电脑连接好,在“我的电脑”中可以看到手机的盘符。 2、将手机开启USB调试模式。在手机设置中找到开发者选项,然后点击“开启USB调试模式”。 3、...
- 电脑怎么激活windows11专业版
-
win11专业版激活方法有多种,以下提供两种常用的激活方式:方法一:使用激活密钥激活。在win11桌面上右键点击“此电脑”,选择“属性”选项。进入属性页面后,点击“更改产品密钥或升级windows”。...
- 华为手机助手下载官网(华为手机助手app下载专区)
-
华为手机助手策略调整,已不支持从应用市场下载手机助手,目前华为手机助手是需要在电脑上下载或更新手机助手到最新版本,https://consumer.huawei.com/cn/support/his...
- 光纤线断了怎么接(宽带光纤线断了怎么接)
-
宽带光纤线断了可以重接,具体操作方法如下:1、光纤连接的时候要根据束管内,同色相连,同芯相连,按顺序进行连接,由大到小。一般有三种连接方法,分别是熔接、活动连接和机械连接。2、连接的时候要开剥光缆,抛...
- win7旗舰版和专业版区别(win7旗舰版跟专业版)
-
1、功能区别:Win7旗舰版比专业版多了三个功能,分别是Bitlocker、BitlockerToGo和多语言界面; 2、用途区别:旗舰版的功能是所有版本中最全最强大的,占用的系统资源,...
- 万能连接钥匙(万能wifi连接钥匙下载)
-
1、首先打开wifi万能钥匙软件,若手机没有开启WLAN,就根据软件提示打开WLAN开关;2、打开WLAN开关后,会显示附近的WiFi,如果知道密码,可点击相应WiFi后点击‘输入密码’连接;3、若不...
- 雨林木风音乐叫什么(雨林木风是啥)
-
雨林木风的创始人是陈年鑫先生。陈年鑫先生于1999年创立了雨林木风公司,其初衷是为满足中国市场对高品质、高性能电脑的需求。在陈年鑫先生的领导下,雨林木风以技术创新、产品质量和客户服务为核心价值,不断推...
- aics6序列号永久序列号(aics6破解序列号)
-
关于AICS6这个版本,虽然是比较久远的版本,但是在功能上也是十分全面和强大的,作为一名平面设计师的话,AICS6的现有的功能已经能够应付几乎所有的设计工作了……到底AICC2019的功能是不是...
- 手机可以装电脑系统吗(手机可以装电脑系统吗怎么装)
-
答题公式1:手机可以通过数据线或无线连接的方式给电脑装系统。手机安装系统需要一定的技巧和软件支持,一般需要通过数据线或无线连接的方式与电脑连接,并下载相应的软件和系统文件进行安装。对于大部分手机用户来...
- 一周热门
- 最近发表
- 标签列表
-
- python判断字典是否为空 (50)
- crontab每周一执行 (48)
- aes和des区别 (43)
- bash脚本和shell脚本的区别 (35)
- canvas库 (33)
- dataframe筛选满足条件的行 (35)
- gitlab日志 (33)
- lua xpcall (36)
- blob转json (33)
- python判断是否在列表中 (34)
- python html转pdf (36)
- 安装指定版本npm (37)
- idea搜索jar包内容 (33)
- css鼠标悬停出现隐藏的文字 (34)
- linux nacos启动命令 (33)
- gitlab 日志 (36)
- adb pull (37)
- python判断元素在不在列表里 (34)
- python 字典删除元素 (34)
- vscode切换git分支 (35)
- python bytes转16进制 (35)
- grep前后几行 (34)
- hashmap转list (35)
- c++ 字符串查找 (35)
- mysql刷新权限 (34)
