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

Sestavte dotaz v GraphiQL

Řada klientů může potřebovat pomoc s používáním sémantika GraphQL a prozkoumávání možností Cloudflare GraphQL API.

Tato stránka podrobně popisuje, jak používat Klient GraphiQL ↗ k sestavení a spuštění dotazu GraphQL.

Všechny podrobnosti o tom, jak konfigurovat klienta zde.

Klikněte do editačního panelu nástroje GraphiQL a přidejte tento základní dotaz, přičemž nahraďte zone-id svým ID zóny Cloudflare:

Klient GraphiQL usnadňuje sestavování dotazů díky doplňování slov. Umístěte kurzor do dotazu, v tomto případě na řádek pod zones, a začněte zadávat hodnotu, čímž tuto funkci aktivujete. Když například napíšete firewall, zobrazí se vyskakovací nabídka s datovými sadami, které vracejí informace o firewallu:

Text ve spodní části seznamu zobrazuje krátký popis dat, která uzel vrací.

Vyberte datovou sadu, kterou chcete dotazovat, a vložte ji. Buď vyberte položku v seznamu, nebo procházejte pomocí kláves se šipkami a stiskněte Return klíč.

Najetím myší na pole zobrazíte tooltip s popisem datasetu. V tomto příkladu najetím na firewallEventsAdaptive uzel zobrazuje tento popis:

Chcete-li zobrazit informace o datové sadě včetně povinných parametrů, vyberte název datové sady (modrý text). Zobrazí se Documentation Explorer se otevře a zobrazí podrobnosti o datasetu:

Upozorňujeme, že filter a limit argumenty jsou povinné, což značí vykřičník (!) za definicí typu (zlatý text). V tomto příkladu orderBy argument není povinný, ale pokud ho použijete, musí mít hodnotu typu ZoneFirewallEventsAdaptiveOrderBy.

Chcete-li si prohlédnout seznam podporovaných polí filtru, vyberte definici typu filtru (zlatý text) v nástroji Documentation Explorer. V tomto příkladu je typ ZoneFirewallEventsAdaptiveFilter_InputObject:

Tento příklad dotazu ukazuje požadovaný filter a limit argumenty pro firewallEventsAdaptive (a stejně tak pro ostatní uzly GraphQL):

Chcete-li si prohlédnout pole, která můžete v dotazu použít, najeďte kurzorem na název datové sady v dotazu a v zobrazené nápovědě vyberte definici datového typu (zlatý text):

Documentation Explorer se otevře a zobrazí seznam polí:

Chcete-li přidat datová pole, která chcete číst, napište otevírací složenou závorku ({) za uzavírací závorkou parametrů a poté začněte psát název pole, které chcete načíst. Pole vyberte pomocí doplňování slov.

Tento příklad dotazu vrací action, datetime, clientRequestHTTPHost, a userAgent pole:

Jakmile zadáte všechna pole, na která se chcete dotazovat, vyberte Přehrát tlačítko pro odeslání dotazu. V podokně s odpovědí se zobrazí data načtená z nakonfigurovaného koncového bodu GraphQL API:

Klient GraphiQL umožňuje používat zástupné symboly pro hodnoty a předávat je pomocí variables část payloadu.

Názvy zástupných symbolů by měly začínat $ znak, takže při použití v dotazu nemusíte zástupné symboly uzavírat do uvozovek.

Hodnoty zástupných symbolů by měly být uvedeny ve formátu JSON, kde se zástupné symboly adresují bez $ znak. Jako příklad, pro zástupný symbol $zoneTag GraphQL API načte hodnotu z pole zoneTag pole objektu dodaných proměnných.

Chcete-li zadat hodnotu zástupného symbolu, vyberte Proměnné dotazu panelu a upravte objekt JSON, který definuje vaše proměnné.

Tento příklad dotazu používá zoneTag proměnnou dotazu, která reprezentuje ID zóny: