Seminar Supabase – API-Entwicklung mit REST, GraphQL und Client-Bibliotheken

Das Seminar behandelt die Entwicklung stabiler Daten- und Anwendungs-APIs auf Basis der automatisch bereitgestellten Schnittstellen und der Supabase-Client-Bibliotheken. Datenmodell, Abfrageverhalten, Sicherheit und API-Verträge werden gemeinsam betrachtet.

Eine abgesicherte Beispielanwendung nutzt REST, GraphQL und einen typisierten Client, behandelt Fehler konsistent und wird mit Vertrags- sowie Berechtigungstests geprüft.

Inhaltsübersicht

• 1. Daten-API und Schemafreigabe verstehen
• 2. REST-Abfragen systematisch entwickeln
• 3. GraphQL-Abfragen und Typen einsetzen
• 4. Client-Bibliotheken und Typsicherheit integrieren
• 5. API-Zugriffe absichern
• 6. Verträge, Versionierung und Betrieb prüfen

1. Daten-API und Schemafreigabe verstehen

In diesem Abschnitt werden Zusammenhang zwischen PostgreSQL-Schemas, Tabellen, Views, Funktionen und automatisch bereitgestellten API-Endpunkten analysieren. Ziel ist ein nachvollziehbares Vorgehen, das sich in Entwicklungs-, Test- und Betriebsumgebungen wiederholen lässt.

Schritt-für-Schritt-Vorgehen

1. Schritt 1 – Ausgangslage erfassen: Fachliche Anforderungen, betroffene Daten, Rollen, Schnittstellen und Qualitätskriterien für „Daten-API und Schemafreigabe verstehen“ in einer Arbeitsmatrix festhalten.
2. Schritt 2 – Zielzustand planen: Zusammenhang zwischen postgresql-schemas, tabellen, views, funktionen und automatisch bereitgestellten api-endpunkten analysieren; dabei Abhängigkeiten, Sicherheitsgrenzen, Fehlerfälle und Rückfallmöglichkeiten ausdrücklich dokumentieren.
3. Schritt 3 – Umsetzung durchführen: Ein abgegrenztes api-schema mit beispieltabellen, views und einer kontrollierten freigabe der benötigten objekte einrichten.
4. Schritt 4 – Prüfung und Nachweis: Positiv-, Negativ- und Wiederholungsfall ausführen, Soll- und Ist-Ergebnis vergleichen, Abweichungen korrigieren und den fertigen Standard versioniert dokumentieren.

Prüfpunkt: Die Umsetzung ist erst abgeschlossen, wenn der vorgesehene Zugriff funktioniert, unzulässige Varianten abgewiesen werden, der Fehlerfall nachvollziehbar bleibt und ein zweiter Durchlauf dasselbe Ergebnis liefert.

2. REST-Abfragen systematisch entwickeln

In diesem Abschnitt werden Filtern, Sortieren, Projektion, Pagination, Beziehungen, Einfügen, Ändern und Löschen als reproduzierbare HTTP-Operationen gestalten. Ziel ist ein nachvollziehbares Vorgehen, das sich in Entwicklungs-, Test- und Betriebsumgebungen wiederholen lässt.

Schritt-für-Schritt-Vorgehen

1. Schritt 1 – Ausgangslage erfassen: Fachliche Anforderungen, betroffene Daten, Rollen, Schnittstellen und Qualitätskriterien für „REST-Abfragen systematisch entwickeln“ in einer Arbeitsmatrix festhalten.
2. Schritt 2 – Zielzustand planen: Filtern, sortieren, projektion, pagination, beziehungen, einfügen, ändern und löschen als reproduzierbare http-operationen gestalten; dabei Abhängigkeiten, Sicherheitsgrenzen, Fehlerfälle und Rückfallmöglichkeiten ausdrücklich dokumentieren.
3. Schritt 3 – Umsetzung durchführen: Eine folge von rest-aufrufen für listen-, detail- und schreiboperationen mit konsistenter fehlerbehandlung implementieren.
4. Schritt 4 – Prüfung und Nachweis: Positiv-, Negativ- und Wiederholungsfall ausführen, Soll- und Ist-Ergebnis vergleichen, Abweichungen korrigieren und den fertigen Standard versioniert dokumentieren.

Prüfpunkt: Die Umsetzung ist erst abgeschlossen, wenn der vorgesehene Zugriff funktioniert, unzulässige Varianten abgewiesen werden, der Fehlerfall nachvollziehbar bleibt und ein zweiter Durchlauf dasselbe Ergebnis liefert.

3. GraphQL-Abfragen und Typen einsetzen

In diesem Abschnitt werden GraphQL-Schema, Auswahlmengen, Beziehungen, Variablen und Mutationen gegenüber dem relationalen Modell abgleichen. Ziel ist ein nachvollziehbares Vorgehen, das sich in Entwicklungs-, Test- und Betriebsumgebungen wiederholen lässt.

Schritt-für-Schritt-Vorgehen

1. Schritt 1 – Ausgangslage erfassen: Fachliche Anforderungen, betroffene Daten, Rollen, Schnittstellen und Qualitätskriterien für „GraphQL-Abfragen und Typen einsetzen“ in einer Arbeitsmatrix festhalten.
2. Schritt 2 – Zielzustand planen: Graphql-schema, auswahlmengen, beziehungen, variablen und mutationen gegenüber dem relationalen modell abgleichen; dabei Abhängigkeiten, Sicherheitsgrenzen, Fehlerfälle und Rückfallmöglichkeiten ausdrücklich dokumentieren.
3. Schritt 3 – Umsetzung durchführen: Typisierte abfragen und mutationen für denselben praxisprozess erstellen und das verhalten mit der rest-variante vergleichen.
4. Schritt 4 – Prüfung und Nachweis: Positiv-, Negativ- und Wiederholungsfall ausführen, Soll- und Ist-Ergebnis vergleichen, Abweichungen korrigieren und den fertigen Standard versioniert dokumentieren.

Prüfpunkt: Die Umsetzung ist erst abgeschlossen, wenn der vorgesehene Zugriff funktioniert, unzulässige Varianten abgewiesen werden, der Fehlerfall nachvollziehbar bleibt und ein zweiter Durchlauf dasselbe Ergebnis liefert.

4. Client-Bibliotheken und Typsicherheit integrieren

In diesem Abschnitt werden Initialisierung, Konfiguration, generierte Typen, Abfrageketten, Sessions und serverseitige Aufrufe in eine Anwendungsarchitektur einordnen. Ziel ist ein nachvollziehbares Vorgehen, das sich in Entwicklungs-, Test- und Betriebsumgebungen wiederholen lässt.

Schritt-für-Schritt-Vorgehen

1. Schritt 1 – Ausgangslage erfassen: Fachliche Anforderungen, betroffene Daten, Rollen, Schnittstellen und Qualitätskriterien für „Client-Bibliotheken und Typsicherheit integrieren“ in einer Arbeitsmatrix festhalten.
2. Schritt 2 – Zielzustand planen: Initialisierung, konfiguration, generierte typen, abfrageketten, sessions und serverseitige aufrufe in eine anwendungsarchitektur einordnen; dabei Abhängigkeiten, Sicherheitsgrenzen, Fehlerfälle und Rückfallmöglichkeiten ausdrücklich dokumentieren.
3. Schritt 3 – Umsetzung durchführen: Einen client-layer mit zentraler konfiguration, typisierten rückgaben, fehlerklassen und austauschbaren umgebungswerten aufbauen.
4. Schritt 4 – Prüfung und Nachweis: Positiv-, Negativ- und Wiederholungsfall ausführen, Soll- und Ist-Ergebnis vergleichen, Abweichungen korrigieren und den fertigen Standard versioniert dokumentieren.

Prüfpunkt: Die Umsetzung ist erst abgeschlossen, wenn der vorgesehene Zugriff funktioniert, unzulässige Varianten abgewiesen werden, der Fehlerfall nachvollziehbar bleibt und ein zweiter Durchlauf dasselbe Ergebnis liefert.

5. API-Zugriffe absichern

In diesem Abschnitt werden Publishable beziehungsweise öffentliche Zugriffe, serverseitige privilegierte Zugriffe, RLS, JWT-Kontext und geheime Schlüssel strikt trennen. Ziel ist ein nachvollziehbares Vorgehen, das sich in Entwicklungs-, Test- und Betriebsumgebungen wiederholen lässt.

Schritt-für-Schritt-Vorgehen

1. Schritt 1 – Ausgangslage erfassen: Fachliche Anforderungen, betroffene Daten, Rollen, Schnittstellen und Qualitätskriterien für „API-Zugriffe absichern“ in einer Arbeitsmatrix festhalten.
2. Schritt 2 – Zielzustand planen: Publishable beziehungsweise öffentliche zugriffe, serverseitige privilegierte zugriffe, rls, jwt-kontext und geheime schlüssel strikt trennen; dabei Abhängigkeiten, Sicherheitsgrenzen, Fehlerfälle und Rückfallmöglichkeiten ausdrücklich dokumentieren.
3. Schritt 3 – Umsetzung durchführen: Positiv- und negativtests für anonyme, authentifizierte, mandantenfremde und administrative anfragen ausführen.
4. Schritt 4 – Prüfung und Nachweis: Positiv-, Negativ- und Wiederholungsfall ausführen, Soll- und Ist-Ergebnis vergleichen, Abweichungen korrigieren und den fertigen Standard versioniert dokumentieren.

Prüfpunkt: Die Umsetzung ist erst abgeschlossen, wenn der vorgesehene Zugriff funktioniert, unzulässige Varianten abgewiesen werden, der Fehlerfall nachvollziehbar bleibt und ein zweiter Durchlauf dasselbe Ergebnis liefert.

6. Verträge, Versionierung und Betrieb prüfen

In diesem Abschnitt werden Änderungen am Datenmodell auf API-Verträge, Kompatibilität, Leistung und Beobachtbarkeit bewerten. Ziel ist ein nachvollziehbares Vorgehen, das sich in Entwicklungs-, Test- und Betriebsumgebungen wiederholen lässt.

Schritt-für-Schritt-Vorgehen

1. Schritt 1 – Ausgangslage erfassen: Fachliche Anforderungen, betroffene Daten, Rollen, Schnittstellen und Qualitätskriterien für „Verträge, Versionierung und Betrieb prüfen“ in einer Arbeitsmatrix festhalten.
2. Schritt 2 – Zielzustand planen: Änderungen am datenmodell auf api-verträge, kompatibilität, leistung und beobachtbarkeit bewerten; dabei Abhängigkeiten, Sicherheitsgrenzen, Fehlerfälle und Rückfallmöglichkeiten ausdrücklich dokumentieren.
3. Schritt 3 – Umsetzung durchführen: Vertragstests, fehlerprotokollierung, migrationsregeln und eine freigabecheckliste für api-änderungen erstellen.
4. Schritt 4 – Prüfung und Nachweis: Positiv-, Negativ- und Wiederholungsfall ausführen, Soll- und Ist-Ergebnis vergleichen, Abweichungen korrigieren und den fertigen Standard versioniert dokumentieren.

Prüfpunkt: Die Umsetzung ist erst abgeschlossen, wenn der vorgesehene Zugriff funktioniert, unzulässige Varianten abgewiesen werden, der Fehlerfall nachvollziehbar bleibt und ein zweiter Durchlauf dasselbe Ergebnis liefert.