From 05e45c41649eea2f3316aed6ccce48004bdfe395 Mon Sep 17 00:00:00 2001 From: Copple <10214025+kiwicopple@users.noreply.github.com> Date: Fri, 14 Jan 2022 15:41:30 +0100 Subject: [PATCH] Adds the Graphql api notes --- web/docs/guides/api.mdx | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/web/docs/guides/api.mdx b/web/docs/guides/api.mdx index 77c845e1814..31aee35820f 100644 --- a/web/docs/guides/api.mdx +++ b/web/docs/guides/api.mdx @@ -9,7 +9,13 @@ import TabItem from '@theme/TabItem'; ## Overview -Supabase generates APIs directly from your database schema. The API is: +Supabase generates three types of API directly from your database schema. + +- REST - interact with your database through a restful interface. +- Realtime - listen to database changes. +- GraphQL - [coming soon](https://supabase.com/blog/2021/12/03/pg-graphql). + +The APIs are: - Instant and auto-generated: as you update your database the changes are immediately accessible through your API. - Self documenting: Supabase generates documentation in the Dashboard which updates as you make database changes. @@ -44,6 +50,11 @@ It provides everything you need from a CRUD API: Supabase provides a Realtime API using [Realtime](https://github.com/supabase/realtime). You can use this to listen to database changes over websockets. Realtime leverages PostgreSQL's built-in logical replication. You can manage your Realtime API simply by managing Postgres publications. +### GraphQL API + +[Coming soon](https://supabase.com/blog/2021/12/03/pg-graphql). We are developing `pg_graphql`, an open source PostgreSQL extension for GraphQL. +`pg_graphql` inspects an existing PostgreSQL schema and reflects a GraphQL schema with resolvers. We will expose `pg_graphql` via the existing REST interface. + ## Getting started