百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

快速将数据库SQL转换为RESTful API

off999 2025-04-09 19:00 19 浏览 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

相关推荐

使用 python-fire 快速构建 CLI_如何搭建python项目架构

命令行应用程序是开发人员最好的朋友。想快速完成某事?只需敲击几下键盘,您就已经拥有了想要的东西。Python是许多开发人员在需要快速组合某些东西时选择的第一语言。但是我们拼凑起来的东西在大多数时候并...

Python 闭包:从底层逻辑到实战避坑,附安全防护指南

一、闭包到底是什么?你可以把闭包理解成一个"带记忆的函数"。它诞生时会悄悄记下自己周围的变量,哪怕跑到别的地方执行,这些"记忆"也不会丢失。就像有人出门时总会带上...

使用Python实现九九乘法表的打印_用python打印一个九九乘法表

任务要求九九乘法表的结构如下:1×1=11×2=22×2=41×3=32×3=63×3=9...1×9=92×9=18...9×9=81使用Python编写程序,按照上述格式打印出完整的九...

吊打面试官(四)--Java语法基础运算符一文全掌握

简介本文介绍了Java运算符相关知识,包含运算规则,运算符使用经验,特殊运算符注意事项等,全文5400字。熟悉了这些内容,在运算符这块就可以吊打面试官了。Java运算符的规则与特性1.贪心规则(Ma...

Python三目运算基础与进阶_python三目运算符判断三个变量

#头条创作挑战赛#Python中你学会了三步运算,你将会省去很多无用的代码,我接下来由基础到进阶的方式讲解Python三目运算基础在Python中,三目运算符也称为条件表达式。它可以通过一行代码实现条...

Python 中 必须掌握的 20 个核心函数——set()详解

set()是Python中用于创建集合的核心函数,集合是一种无序、不重复元素的容器,非常适合用于成员检测、去重和数学集合运算。一、set()的基本用法1.1创建空集合#创建空集合empty_se...

15个让Python编码效率翻倍的实用技巧

在软件开发领域,代码质量往往比代码数量更重要。本文整理的15个Python编码技巧,源自开发者在真实项目中验证过的工作方法,能够帮助您用更简洁的代码实现更清晰的逻辑。这些技巧覆盖基础语法优化到高级特性...

《Python从小白到入门》自学课程目录汇总(和猫妹学Python)

小朋友们好,大朋友们好!不知不觉,这套猫妹自学Python基础课程已经结束了,猫妹体会到了水滴石穿的力量。水一直向下滴,时间长了能把石头滴穿。只要坚持不懈,细微之力也能做出很难办的事。就比如咱们的学习...

8÷2(2+2) 等于1还是16?国外网友为这道小学数学题吵疯了……

近日,国外网友因为一道小学数学题在推特上争得热火朝天。事情的起因是一个推特网友@pjmdoll发布了一条推文,让他的关注者解答一道数学题:Viralmathequationshavebeen...

Python学不会来打我(21)python表达式知识点汇总

在Python中,表达式是由变量、运算符、函数调用等组合而成的语句,用于产生值或执行特定操作。以下是对Python中常见表达式的详细讲解:1.1算术表达式涉及数学运算的表达式。例如:a=5b...

Python运算符:数学助手,轻松拿咧

Python中的运算符就像是生活中的数学助手,帮助我们快速准确地完成这些计算。比如购物时计算总价、做家务时分配任务等。这篇文章就来详细聊聊Python中的各种运算符,并通过实际代码示例帮助你更好地理解...

Python学不会来打我(17)逻辑运算符的使用方法与使用场景

在Python编程中,逻辑运算符(LogicalOperators)是用于组合多个条件表达式的关键工具。它们可以将多个布尔表达式连接起来,形成更复杂的判断逻辑,并返回一个布尔值(True或Fa...

Python编程基础:运算符的优先级_python中的运算符优先级问题

多个运算符同时出现在一个表达式中时,先执行哪个,后执行哪个,这就涉及运算符的优先级。如数学表达式,有+、-、×、÷、()等,优先级顺序是()、×、÷、+、-,如5+(5-3)×4÷2,先计算(5-3)...

Python运算符与表达式_python中运算符&的功能

一、运算符分类总览1.Python运算符全景图2.运算符优先级表表1.3.1Python运算符优先级(从高到低)优先级运算符描述结合性1**指数右→左2~+-位非/一元加减右→左3*//...

Python操作Excel:从基础到高级的深度实践

Python凭借其丰富的库生态系统,已成为自动化处理Excel数据的强大工具。本文将深入探讨五个关键领域,通过实际代码示例展示如何利用Python进行高效的Excel操作,涵盖数据处理、格式控制、可视...

取消回复欢迎 发表评论: