Creating API Routes
API routes are automatically created when you create Postgres Tables, Views, or Functions.
Create a table
Let's create our first API route by creating a table called todos
to store tasks.
This creates a corresponding route todos
which can accept GET
, POST
, PATCH
, & DELETE
requests.
- Go to the Table editor page in the Dashboard.
- Click New Table and create a table with the name
todos
. - Click Save.
- Click New Column and create a column with the name
task
and typetext
. - Click Save.
API URL and keys
Every Supabase project has a unique API URL. Your API is secured behind an API gateway which requires an API Key for every request.
- Go to the Settings page in the Dashboard.
- Click API in the sidebar.
- Find your API
URL
,anon
, andservice_role
keys on this page.
The REST API is accessible through the URL https://<project_ref>.supabase.co/rest/v1
Both of these routes require the anon
key to be passed through an apikey
header.
Using the API
You can interact with your API directly via HTTP requests, or you can use the client libraries which we provide.
Let's see how to make a request to the todos
table which we created in the first step,
using the API URL (SUPABASE_URL
) and Key (SUPABASE_ANON_KEY
) we provided:
_10// Initialize the JS client_10import { createClient } from '@supabase/supabase-js'_10const supabase = createClient(SUPABASE_URL, SUPABASE_ANON_KEY)_10_10// Make a request_10const { data: todos, error } = await supabase.from('todos').select('*')
JS Reference: select(), insert(), update(), upsert(), delete(), rpc() (call Postgres functions).