Einführung in die GraphQL API
Unsere API verwendet GraphQL, eine moderne und flexible Abfragesprache für APIs. Wenn Sie bisher nur mit REST-APIs gearbeitet haben, werden Ihnen einige Konzepte neu, aber sehr nützlich erscheinen.
Was ist GraphQL?
Im Gegensatz zu traditionellen REST-APIs, die oft viele verschiedene Endpunkte für unterschiedliche Ressourcen haben (z.B. /users, /products, /orders), verwendet eine GraphQL-API typischerweise einen einzigen Endpunkt (in unserem Fall https://{IHRE_URL}/graphql).
Der größte Vorteil von GraphQL ist, dass Sie als Client genau die Daten anfordern, die Sie benötigen – nicht mehr und nicht weniger. Sie beschreiben die Struktur der gewünschten Daten in einer Anfrage (einer “Query”), und der Server liefert eine JSON-Antwort, die exakt dieser Struktur entspricht. Dies vermeidet das Abrufen von zu vielen (Over-fetching) oder zu wenigen (Under-fetching) Daten.
Die zwei wichtigsten Operationstypen sind:
- Query: Zum Lesen und Abfragen von Daten.
- Mutation: Zum Erstellen, Ändern oder Löschen von Daten.
Der interaktive GraphQL Explorer (Banana Cake Pop)
Um Ihnen den Einstieg und das Experimentieren mit unserer API so einfach wie möglich zu machen, stellen wir einen interaktiven GraphQL Explorer direkt in Ihrem Browser zur Verfügung. Dieses Tool basiert auf Banana Cake Pop von den Machern von Hot Chocolate.
So greifen Sie darauf zu:
Navigieren Sie einfach zu https://{IHRE_URL}/graphql in Ihrem Webbrowser.
Was der Explorer Ihnen bietet:
- Schema-Erkundung: Sie können das gesamte API-Schema durchsuchen, um zu sehen, welche Queries, Mutations und Datentypen verfügbar sind.
- Intelligente Autovervollständigung: Beim Schreiben Ihrer Queries schlägt Ihnen der Editor automatisch verfügbare Felder und Argumente vor.
- Direktes Testen: Führen Sie Queries und Mutations direkt im Browser aus und sehen Sie sich die Ergebnisse sofort an.
- Integrierte Dokumentation: Klicken Sie auf ein beliebiges Feld oder einen Typ im Schema, um eine Beschreibung und Details dazu zu erhalten.
Authentifizierung im Explorer
Einfach und automatisch: Wenn Sie in unserer Webanwendung angemeldet sind und den Explorer im selben Browser öffnen, wird Ihre bestehende Login-Sitzung automatisch für die API-Anfragen verwendet.
- Keine zusätzliche Konfiguration nötig.
- Öffnen Sie einfach
https://{IHRE_URL}/graphqlund Sie können sofort loslegen, Anfragen mit Ihren Benutzerrechten auszuführen.
Wenn Sie Ihre Anfragen dann von einer externen Anwendung aus abschicken wollen, müssen Sie sich mittels API-Schlüssel Authentifizieren. Sehen Sie dazu API Authentifizierung
Mehr über GraphQL lernen
GraphQL ist mächtig und flexibel. Um die Konzepte im Detail zu verstehen und das volle Potenzial auszuschöpfen, empfehlen wir die offizielle Dokumentation und die Lernressourcen auf der GraphQL-Webseite.
Besuchen Sie: graphql.org/learn