REST API

创建API路由


当您创建Postgres表、视图或函数时,API路由会自动生成。

创建表

让我们通过创建一个名为todos的表来存储任务,从而创建第一个API路由。 这将生成对应的todos路由,可以接受GETPOSTPATCHDELETE请求。

  1. 进入仪表盘的表编辑器页面
  2. 点击新建表并创建名为todos的表
  3. 点击保存
  4. 点击新建列并创建名为task、类型为text的列
  5. 点击保存

API URL和密钥

每个Supabase项目都有唯一的API URL。您的API通过API网关进行保护,每个请求都需要API密钥。

  1. 进入仪表盘的设置页面
  2. 点击侧边栏中的API
  3. 在此页面查找您的APIURLanonservice_role密钥

REST API可通过以下URL访问:https://<project_ref>.supabase.co/rest/v1

这两个路由都需要通过apikey请求头传递anon密钥。

使用 API

您可以直接通过 HTTP 请求与 API 交互,也可以使用我们提供的客户端库。

让我们看看如何使用第一步中提供的 API URL (SUPABASE_URL) 和密钥 (SUPABASE_ANON_KEY) 向 todos 表发起请求:

1
2
3
4
5
6
// 初始化 JS 客户端import { createClient } from '@supabase/supabase-js'const supabase = createClient(SUPABASE_URL, SUPABASE_ANON_KEY)// 发起请求const { data: todos, error } = await supabase.from('todos').select('*')

JavaScript 参考文档: select(), insert(), update(), upsert(), delete(), rpc() (调用 Postgres 函数)。