← Analytics / analytics / graphql-api / getting-started

Prozkoumejte schéma GraphQL

Mnoho klientů GraphQL umožňuje procházet schéma GraphQL tím, že se starají o introspekce. Na této stránce se budeme věnovat klientům GraphiQL a Altair.

GraphiQL ↗ a Altair ↗ jsou open-source klienti GraphQL, kteří nabízejí nástroj pro sestavení dotazu, jeho spuštění a prohlédnutí výsledků. Navíc vám umožňují procházet schéma GraphQL.

Než začnete, nezapomeňte konfigurovat endpoint API a HTTP hlavičky.

Snímky obrazovky níže pocházejí z GraphiQL. Altair ale nabízí stejnou funkcionalitu, takže se stejnými pokyny bez potíží prozkoumáte schéma i v něm.

Chcete-li otevřít GraphiQL Documentation Explorer, vyberte Docs odkaz v záhlaví panelu odpovědi:

Documentation Explorer se otevře a zobrazí seznam dostupných objektů:

Objekty v Documentation Explorer použijte tuto syntaxi:

  object-name: object-type-definition

Při prvním otevření Documentation Explorer panelu, mutation a query kořenové typy zobrazují:

V tomto příkladu query je název kořene a Query je definice typu.

Klikněte na definice typu uzlu a zobrazte pole, která poskytuje. Documentation Explorer také zobrazuje popisy jednotlivých uzlů.

Vyberte například Dotaz definici typu. Documentation Explorer zobrazuje pole, která Query poskytuje. V tomto příkladu jsou pole cost a viewer:

Chcete-li prozkoumat schéma, vyberte názvy objektů a definic. Můžete také použít vyhledávací pole (ikona lupy) a odkazy drobečkové navigace v záhlaví.

Klikněte na definici typu viewer pole (zlatý text) pro zobrazení jeho dílčích polí. viewer pole poskytuje dílčí pole, která umožňují dotazovat se na accounts nebo zones data:

accounts a zones uzly přijímají argumenty, kterými určíte, na jaký dataset se má dotaz zaměřit.

Například zones může přijímat filtr typu ZoneFilter_InputObject typ jako argument. Chcete-li zobrazit pole dostupná k filtrování, vyberte ZoneFilter_InputObject.

Chcete-li zobrazit seznam datových sad dostupných pro dotazování, vyberte zóna definici typu (zlatý text):

Seznam datasetů se zobrazí v Pole sekci, každá se seznamem platných argumentů a stručným popisem. Argumenty, které končí vykřičníkem (!) jsou povinné.

Pomocí vyhledávacího pole (ikona lupy) najděte konkrétní datasety:

Chcete-li vybrat datovou sadu, vyberte její název.

Zobrazí se definice datové sady. Tento příklad ukazuje firewallEventsAdaptive datová sada:

Chcete-li zobrazit dostupná pole pro konkrétní datovou sadu, vyberte její typovou definici (zlatý text).

Vyberte například ZoneFirewallEventsAdaptive definici typu a zobrazte si pole dostupná pro firewallEventsAdaptive datová sada:

Zobrazí se seznam polí:

Informace o používání GraphiQL najdete na této průvodce.