Ataccama Using Playground
🎯 Definicja GraphiQL (dawniej GraphQL Playground) to interaktywne, zintegrowane środowisko programistyczne (IDE) służące do pisania, testowania oraz eksplorowania API GraphQL bezpośrednio w Ataccama ONE. Służy jako konsola deweloperska do uruchamiania zapytań (queries), mutacji (mutations) i subskrypcji (subscriptions).
🔑 Kluczowe punkty
- Dostępne pod adresem URL
<adres_ataccama>/playground/. - Wspiera automatyczne uzupełnianie kodu (Content Assist za pomocą skrótu
Ctrl + Space) ułatwiające przeglądanie typów i schematu danych. - Posiada panel historii, który zapamiętuje ostatnio wykonywane zapytania.
- Uwierzytelnianie odbywa się automatycznie w tle przy użyciu aktywnej sesji użytkownika (Bearer token).
- Pozwala na konfigurację zmiennych (Variables) w dedykowanym panelu w formacie JSON.
📚 Jak korzystać z GraphiQL (Krok po Kroku)
- Otwarcie środowiska: Przejdź w przeglądarce pod adres
<adres_ataccama>/playground/. Nastąpi automatyczne przekierowanie do interfejsu GraphiQL. - Uwierzytelnianie: Sprawdź, czy jesteś zalogowany w aplikacji głównej Ataccama ONE. Playground automatycznie pobiera token Bearer z Twojej aktywnej sesji przeglądarki.
- Konstruowanie zapytania: Wpisz swoje zapytanie (Query) lub mutację (Mutation) w lewym panelu edytora.
- Zmienne (Variables): Jeśli Twoje zapytanie parametryzuje dane wejściowe, zdefiniuj je w panelu Query Variables na dole edytora w formacie JSON:
{ "gid": "0726c74e-fc9e-40ad-a29d-23ec1dac8769" } - Wykonanie operacji: Kliknij przycisk Execute (ikona trójkąta/odtwarzania) na środku ekranu.
- Analiza wyniku: Przejrzyj odpowiedź z serwera w prawym panelu wynikowym.
💡 Przykład zastosowania
Podczas pisania skomplikowanych zapytań o powiązania encji metadanych (np. sprawdzanie atrybutów tabeli), możesz nacisnąć Ctrl + Space wewnątrz nawiasów klamrowych. GraphiQL wyświetli listę wszystkich dostępnych pól i typów, które możesz pobrać z modelu danych.
📌 Źródła
- Oficjalna dokumentacja GraphiQL
- Ataccama ONE Developer Guide