REST API

REST API


Supabase 能够直接从您的数据库模式自动生成 API,使您可以通过 RESTful 接口直接从浏览器连接到数据库。

该 API 由您的数据库自动生成,旨在让您无需编写任何代码即可快速开始构建。

您可以直接从浏览器使用它们(双层架构),或作为自有 API 服务器的补充(三层架构)。

功能特性

Supabase 使用 PostgREST 提供 RESTful API。这是在 PostgreSQL 之上的一个非常轻量级的 API 层。它通过 URL https://<project_ref>.supabase.co/rest/v1/ 暴露了 CRUD API 所需的所有功能。

REST 接口会自动反映您数据库的模式,并具有以下特点:

  • 即时自动生成
    当您更新数据库时,变更会立即通过 API 生效。
  • 自文档化
    Supabase 会在仪表板中生成文档,随着数据库变更自动更新。
  • 安全
    API 配置为与 PostgreSQL 的行级安全机制协同工作,部署在启用密钥认证的 API 网关之后。
  • 快速
    我们的基准测试显示基本读取操作比 Firebase 快 300% 以上。API 是 PostgreSQL 之上的极薄层,大部分繁重工作都由 PostgreSQL 处理。
  • 可扩展
    API 可以处理数千个并发请求,非常适合无服务器(Serverless)工作负载。

反射式 API 设计保留了 PostgreSQL 的大部分能力,包括:

  • 基本 CRUD 操作(创建/读取/更新/删除)
  • 表/视图之间任意深度的关联关系,返回表类型的函数也可以嵌套关联表/视图
  • 支持 PostgreSQL 视图、物化视图和外部表
  • 支持 PostgreSQL 函数
  • 用户定义的计算列和计算关系
  • PostgreSQL 安全模型 - 包括行级安全、角色和权限

REST API 将所有请求解析为单个 SQL 语句,从而实现快速响应和高吞吐量。

参考文档:

API URL 与密钥

您可以在控制面板中找到API URL和密钥。