Seminar Sanity APIs, GraphQL und JavaScript Client

Im Mittelpunkt stehen programmatischer Zugriff über HTTP-Schnittstellen, GraphQL und den JavaScript Client. Die Inhalte werden an einem durchgängigen Praxisfall erarbeitet und so strukturiert, dass fachliche Entscheidungen, technische Umsetzung und betriebliche Anforderungen nachvollziehbar zusammenwirken.

Inhaltsübersicht

1. Zielsetzung
2. Zielgruppe
3. Voraussetzungen
4. Seminarinhalte
5. Praxisübungen
6. Qualitätssicherung
7. Methodik

Zielsetzung

Das Seminar entwickelt die erforderlichen Kenntnisse systematisch von der Einordnung bis zur kontrollierten Umsetzung.

• geeignete Zugriffsschnittstellen je Anwendungsfall auswählen
• Lese- und Schreibzugriffe sicher implementieren
• Fehlerbehandlung, Authentifizierung und Typisierung belastbar gestalten

Zielgruppe

Webentwicklungs-, Integrations- und Plattformteams.

Voraussetzungen

JavaScript- oder TypeScript-Grundkenntnisse sowie grundlegendes Verständnis strukturierter Inhalte.

Seminarinhalte

1. API-Landschaft

Dieser Baustein behandelt die Aufgabe, Query-, Mutation-, Assets-, History- und weitere Schnittstellen nach Verantwortungsbereich einordnen. Die Bearbeitung folgt einem kontrollierbaren Vier-Schritte-Verfahren.

1. Schritt 1: Ausgangslage erfassen. Fachliche Ziele, beteiligte Rollen, vorhandene Daten und technische Randbedingungen für „Query-, Mutation-, Assets-, History- und weitere Schnittstellen nach Verantwortungsbereich einordnen“ werden dokumentiert.
2. Schritt 2: Lösung umsetzen. Die erforderliche Konfiguration oder Implementierung für „Query-, Mutation-, Assets-, History- und weitere Schnittstellen nach Verantwortungsbereich einordnen“ wird in nachvollziehbaren Teilschritten aufgebaut.
3. Schritt 3: Verhalten prüfen. Normalfälle, Grenzfälle, Berechtigungen, fehlerhafte Eingaben und Wiederholbarkeit werden anhand definierter Prüffälle kontrolliert.
4. Schritt 4: Betrieb absichern. Entscheidungen, Qualitätskriterien, Verantwortlichkeiten, Wartungshinweise und erforderliche Rückfallmaßnahmen werden festgehalten.

2. Projekt- und Dataset-Kontext

Dieser Baustein behandelt die Aufgabe, Projektkennung, Dataset, API-Version und Perspektive korrekt konfigurieren. Die Bearbeitung folgt einem kontrollierbaren Vier-Schritte-Verfahren.

1. Schritt 1: Ausgangslage erfassen. Fachliche Ziele, beteiligte Rollen, vorhandene Daten und technische Randbedingungen für „Projektkennung, Dataset, API-Version und Perspektive korrekt konfigurieren“ werden dokumentiert.
2. Schritt 2: Lösung umsetzen. Die erforderliche Konfiguration oder Implementierung für „Projektkennung, Dataset, API-Version und Perspektive korrekt konfigurieren“ wird in nachvollziehbaren Teilschritten aufgebaut.
3. Schritt 3: Verhalten prüfen. Normalfälle, Grenzfälle, Berechtigungen, fehlerhafte Eingaben und Wiederholbarkeit werden anhand definierter Prüffälle kontrolliert.
4. Schritt 4: Betrieb absichern. Entscheidungen, Qualitätskriterien, Verantwortlichkeiten, Wartungshinweise und erforderliche Rückfallmaßnahmen werden festgehalten.

3. JavaScript Client

Dieser Baustein behandelt die Aufgabe, einen typisierten Client für Server- und Browserkontexte einrichten. Die Bearbeitung folgt einem kontrollierbaren Vier-Schritte-Verfahren.

1. Schritt 1: Ausgangslage erfassen. Fachliche Ziele, beteiligte Rollen, vorhandene Daten und technische Randbedingungen für „einen typisierten Client für Server- und Browserkontexte einrichten“ werden dokumentiert.
2. Schritt 2: Lösung umsetzen. Die erforderliche Konfiguration oder Implementierung für „einen typisierten Client für Server- und Browserkontexte einrichten“ wird in nachvollziehbaren Teilschritten aufgebaut.
3. Schritt 3: Verhalten prüfen. Normalfälle, Grenzfälle, Berechtigungen, fehlerhafte Eingaben und Wiederholbarkeit werden anhand definierter Prüffälle kontrolliert.
4. Schritt 4: Betrieb absichern. Entscheidungen, Qualitätskriterien, Verantwortlichkeiten, Wartungshinweise und erforderliche Rückfallmaßnahmen werden festgehalten.

4. Lesende Zugriffe

Dieser Baustein behandelt die Aufgabe, parametrisierte Abfragen ausführen und Ergebnisse in Anwendungsmodelle überführen. Die Bearbeitung folgt einem kontrollierbaren Vier-Schritte-Verfahren.

1. Schritt 1: Ausgangslage erfassen. Fachliche Ziele, beteiligte Rollen, vorhandene Daten und technische Randbedingungen für „parametrisierte Abfragen ausführen und Ergebnisse in Anwendungsmodelle überführen“ werden dokumentiert.
2. Schritt 2: Lösung umsetzen. Die erforderliche Konfiguration oder Implementierung für „parametrisierte Abfragen ausführen und Ergebnisse in Anwendungsmodelle überführen“ wird in nachvollziehbaren Teilschritten aufgebaut.
3. Schritt 3: Verhalten prüfen. Normalfälle, Grenzfälle, Berechtigungen, fehlerhafte Eingaben und Wiederholbarkeit werden anhand definierter Prüffälle kontrolliert.
4. Schritt 4: Betrieb absichern. Entscheidungen, Qualitätskriterien, Verantwortlichkeiten, Wartungshinweise und erforderliche Rückfallmaßnahmen werden festgehalten.

5. Schreibende Zugriffe

Dieser Baustein behandelt die Aufgabe, Transaktionen, Patches und idempotente Mutationen kontrolliert einsetzen. Die Bearbeitung folgt einem kontrollierbaren Vier-Schritte-Verfahren.

1. Schritt 1: Ausgangslage erfassen. Fachliche Ziele, beteiligte Rollen, vorhandene Daten und technische Randbedingungen für „Transaktionen, Patches und idempotente Mutationen kontrolliert einsetzen“ werden dokumentiert.
2. Schritt 2: Lösung umsetzen. Die erforderliche Konfiguration oder Implementierung für „Transaktionen, Patches und idempotente Mutationen kontrolliert einsetzen“ wird in nachvollziehbaren Teilschritten aufgebaut.
3. Schritt 3: Verhalten prüfen. Normalfälle, Grenzfälle, Berechtigungen, fehlerhafte Eingaben und Wiederholbarkeit werden anhand definierter Prüffälle kontrolliert.
4. Schritt 4: Betrieb absichern. Entscheidungen, Qualitätskriterien, Verantwortlichkeiten, Wartungshinweise und erforderliche Rückfallmaßnahmen werden festgehalten.

6. GraphQL

Dieser Baustein behandelt die Aufgabe, Schema-Bereitstellung, Abfragen und Grenzen der GraphQL-Schnittstelle bewerten. Die Bearbeitung folgt einem kontrollierbaren Vier-Schritte-Verfahren.

1. Schritt 1: Ausgangslage erfassen. Fachliche Ziele, beteiligte Rollen, vorhandene Daten und technische Randbedingungen für „Schema-Bereitstellung, Abfragen und Grenzen der GraphQL-Schnittstelle bewerten“ werden dokumentiert.
2. Schritt 2: Lösung umsetzen. Die erforderliche Konfiguration oder Implementierung für „Schema-Bereitstellung, Abfragen und Grenzen der GraphQL-Schnittstelle bewerten“ wird in nachvollziehbaren Teilschritten aufgebaut.
3. Schritt 3: Verhalten prüfen. Normalfälle, Grenzfälle, Berechtigungen, fehlerhafte Eingaben und Wiederholbarkeit werden anhand definierter Prüffälle kontrolliert.
4. Schritt 4: Betrieb absichern. Entscheidungen, Qualitätskriterien, Verantwortlichkeiten, Wartungshinweise und erforderliche Rückfallmaßnahmen werden festgehalten.

7. Authentifizierung und CORS

Dieser Baustein behandelt die Aufgabe, Tokens, Origins und Laufzeitumgebungen sicher konfigurieren. Die Bearbeitung folgt einem kontrollierbaren Vier-Schritte-Verfahren.

1. Schritt 1: Ausgangslage erfassen. Fachliche Ziele, beteiligte Rollen, vorhandene Daten und technische Randbedingungen für „Tokens, Origins und Laufzeitumgebungen sicher konfigurieren“ werden dokumentiert.
2. Schritt 2: Lösung umsetzen. Die erforderliche Konfiguration oder Implementierung für „Tokens, Origins und Laufzeitumgebungen sicher konfigurieren“ wird in nachvollziehbaren Teilschritten aufgebaut.
3. Schritt 3: Verhalten prüfen. Normalfälle, Grenzfälle, Berechtigungen, fehlerhafte Eingaben und Wiederholbarkeit werden anhand definierter Prüffälle kontrolliert.
4. Schritt 4: Betrieb absichern. Entscheidungen, Qualitätskriterien, Verantwortlichkeiten, Wartungshinweise und erforderliche Rückfallmaßnahmen werden festgehalten.

8. Fehlerbehandlung und Beobachtbarkeit

Dieser Baustein behandelt die Aufgabe, Rate Limits, Netzwerkfehler und fachliche Fehler strukturiert behandeln. Die Bearbeitung folgt einem kontrollierbaren Vier-Schritte-Verfahren.

1. Schritt 1: Ausgangslage erfassen. Fachliche Ziele, beteiligte Rollen, vorhandene Daten und technische Randbedingungen für „Rate Limits, Netzwerkfehler und fachliche Fehler strukturiert behandeln“ werden dokumentiert.
2. Schritt 2: Lösung umsetzen. Die erforderliche Konfiguration oder Implementierung für „Rate Limits, Netzwerkfehler und fachliche Fehler strukturiert behandeln“ wird in nachvollziehbaren Teilschritten aufgebaut.
3. Schritt 3: Verhalten prüfen. Normalfälle, Grenzfälle, Berechtigungen, fehlerhafte Eingaben und Wiederholbarkeit werden anhand definierter Prüffälle kontrolliert.
4. Schritt 4: Betrieb absichern. Entscheidungen, Qualitätskriterien, Verantwortlichkeiten, Wartungshinweise und erforderliche Rückfallmaßnahmen werden festgehalten.

Praxisübungen

1. Einen Server-Client mit parametrisierter Abfrage implementieren.
2. Eine transaktionale Aktualisierung mit Konfliktbehandlung entwickeln.
3. GraphQL und GROQ für denselben Anwendungsfall vergleichen.

Qualitätssicherung

• Jeder Arbeitsschritt wird mit einem nachvollziehbaren Soll-Ergebnis abgeschlossen.
• Konfigurationen und Implementierungen werden gegen Normal-, Grenz- und Fehlerfälle geprüft.
• Fachliche und technische Entscheidungen werden mit Annahmen und Auswirkungen dokumentiert.
• Die Abschlussprüfung bewertet Vollständigkeit, Wartbarkeit, Sicherheit und betriebliche Eignung.

Methodik

Fachliche Einordnung, Live-Demonstration, angeleitete Umsetzung, eigenständige Übungen, Review und Fehleranalyse wechseln sich ab. Der Praxisfall wächst über die einzelnen Bausteine hinweg zu einer konsistenten Gesamtlösung.