Zum Inhalt springen
BeispielWerk
English

GraphQL Beispiele: Schema, Query, Mutation, Antwort

GraphQL ist eine Abfragesprache für APIs, bei der der Client die gewünschten Felder selbst festlegt. Die Snippets zeigen ein Schema für Kunden, Produkte und Bestellungen, dazu Query, Variablen, Mutation, Fragment, Alias, Direktive, eine Introspection-Abfrage und Beispielantworten. Fehler kommen häufig mit HTTP 200 und einem errors-Feld zurück.

9 Varianten auf einer Seite, jede mit eigenem Kopier- oder Download-Knopf. Darunter: 2× Fiktiv.

  • GraphQL: Schema für Kunden, Produkte und Bestellungen

    type Kunde {
      id: ID!
      kundennummer: String! …
  • GraphQL: Abfrage eines Kunden mit Bestellungen

    query KundeMitBestellungen($id: ID!) {
      kunde(id: $id) {
        kundennummer …
  • GraphQL: Variablen für die Abfrage (JSON)

    {
      "id": "1"
    }
  • GraphQL: Mutation mit Eingabeobjekt

    mutation Anlegen($input: BestellungInput!) {
      bestellungAnlegen(input: $input) {
        id …
  • GraphQL: Fragment, Alias und Direktive

    query Vergleich($mitBestand: Boolean!) {
      erstes: produkte(suche: "Notiz") { ...Felder }
      zweites: produkte(suche: "Kugel") { ...Felder } …
  • GraphQL: HTTP-Anfrage mit curl

    curl -X POST https://example.com/graphql \
      -H "Content-Type: application/json" \
      -d '{"query": "query($id: ID!) { kunde(id: $id) { nachname } }", "variables": {"id": "1"}}'
  • GraphQL: Antwort mit DatenFiktiv

    {
      "data": {
        "kunde": { …
  • GraphQL: Antwort mit Fehler (HTTP 200)Fiktiv

    {
      "data": null,
      "errors": [ …

    GraphQL liefert Fehler meist mit HTTP 200 und einem errors-Feld; der Code in extensions ist Konvention des Servers.

  • GraphQL: kleine Introspection-Abfrage

    {
      __schema {
        queryType { name } …

Weitere Themen in Datenformate & Snippets