BreedersDB

GraphQL Explorer

⚠️ Wichtig: Lies zuerst die API Einführung, bevor du die Beispiele hier ausprobierst.

Der GraphQL Explorer ist ein interaktives Tool, mit dem du die API erkunden und Abfragen testen kannst, ohne Code schreiben zu müssen.

Inhalt

Zugriff auf den Explorer

  1. Öffne den API Explorer.
  2. Gib deine BreedersDB-URL ein ({deine-instanz}.breedersdb.com).
  3. Gib dein Persönliches Zugangs-Token ein.
  4. Klicke auf Connect.

Nach erfolgreicher Verbindung siehst du den GraphQL Explorer:

GraphQL Explorer Interface

Explorer-Funktionen

Der GraphQL Explorer besteht aus mehreren Bereichen, die dir beim Erstellen und Testen von Abfragen helfen:

Hier schreibst du deine GraphQL-Abfragen. Der Editor bietet:

  • Syntax-Hervorhebung: Verschiedene Farben für Schlüsselwörter, Felder und Werte
  • Auto-Vervollständigung: Drücke CTRL+Space, um Vorschläge für Felder und Typen zu sehen
  • Query-Validierung: Der Editor prüft deine Abfrage auf Fehler, bevor du sie ausführst
  • Tastaturkürzel: Schnellere Bearbeitung mit Shortcuts

Variablen-Editor

Unter dem Query-Editor kannst du Variablen für deine Abfragen definieren:

  • Variablen werden im JSON-Format eingegeben
  • Ermöglicht wiederverwendbare, dynamische Abfragen
  • Werte können geändert werden, ohne die gesamte Abfrage neu zu schreiben

Response-Viewer (Rechts)

Nach der Ausführung einer Abfrage siehst du hier die Antwort:

  • Zeigt die zurückgegebenen Daten im JSON-Format
  • Du kannst Teile der Antwort auf- und zuklappen, um sie genauer zu untersuchen
  • Zeigt nützliche Informationen wie die Anzahl der Anfragen und die Ausführungszeit

Schema-Dokumentation

Das Buch-Icon links oben öffnet die Schema-Dokumentation:

  • Zeigt alle verfügbaren Datentypen, Felder und deren Beschreibungen
  • Du kannst nach Typen und Feldern suchen
  • Hilft dir zu verstehen, welche Daten verfügbar sind, bevor du danach fragst

Query-History

Das Uhr-Icon zeigt deine Abfrage-Historie:

  • Zeigt alle zuvor ausgeführten Abfragen
  • Ermöglicht das Wiederverwenden und Anpassen früherer Abfragen
  • Nützlich zum Debuggen und Lernen

Explorer

Das Ordner-Icon öffnet den Explorer-Bereich:

  • Zeigt die Struktur des GraphQL-Schemas
  • Hier kannst du dir deine Queries zusammenklicken

Deine erste Abfrage

Abfrage erstellen

  1. Im Query-Editor: Beginne mit dem Schlüsselwort query, gefolgt von einem Namen PlantsQuery. Dann öffne geschweifte Klammern {} und gib den gewünschten Endpunkt ein, z.B. plants. Öffne erneut geschweifte Klammern, um die Felder anzugeben, die du abrufen möchtest:
query PlantsQuery {
  plants {
    id
    label_id
    plant_group_name
    plant_row {
      name
      orchard {
        name
      }
    }
  }
}
  1. Drücke CTRL+Space, um Vorschläge für verfügbare Felder zu sehen.
  2. Du kannst Argumente zu Feldern hinzufügen, z.B. um Ergebnisse zu begrenzen:
query PlantsQuery {
  plants(limit: 10) {
    id
    label_id
    plant_group_name
    plant_row {
      name
      orchard {
        name
      }
    }
  }
}

Variablen verwenden

Für wiederverwendbare, dynamische Abfragen kannst du Variablen verwenden:

  1. Klicke auf “Variables” unter dem Query-Editor.
  2. Gib deine Variablen im JSON-Format ein:
{
  "limit": 10
}
  1. Verwende die Variable in deiner Abfrage, indem du $ vor den Variablennamen setzt und den Typ angibst:
query PlantsQuery($limit: Int!) {
  plants(limit: $limit) {
    id
    label_id
    plant_group_name
    plant_row {
      name
      orchard {
        name
      }
    }
  }
}

Abfrage ausführen

  1. Stelle sicher, dass deine Abfrage gültig ist und keine Fehler angezeigt werden.
  2. Klicke auf den Play-Button (Dreieck) oder drücke CTRL+Enter (bzw. CMD+Enter auf Mac).
  3. Die Antwort wird im rechten Panel angezeigt.

Wichtig

Begrenze die Anzahl der zurückgegebenen Einträge mit dem Argument limit, um die Leistung zu optimieren und Zeitüberschreitungen zu vermeiden.

Mehr dazu findest du im Abschnitt Pagination.

Weitere Ressourcen

Für eine ausführlichere Anleitung zur Verwendung des GraphQL Explorers siehe: GraphiQL Explorer: A Beginner’s Guide

BreedersDB nutzt den GraphQL Dialekt von Hasura. Details dazu findest du im Hasura GraphQL Guide resp. in der Hasura GraphQL Referenz.