GraphQL Introspection
🎯 Definicja Introspekcja (Introspection) to wbudowana funkcja w technologii GraphQL, która umożliwia klientom odpytywanie serwera o szczegółowe informacje na temat jego schematu (schema). Klient może sprawdzić, jakie zapytania (queries), mutacje (mutations) i subskrypcji (subscriptions) są obsługiwane, a także jakie typy obiektów, pola i argumenty są dostępne w systemie.
🔑 Kluczowe punkty
- Umożliwia dynamiczne generowanie dokumentacji, autouzupełnianie kodu (np. w GraphiQL) i walidację zapytań przed wysłaniem.
- W Ataccama ONE można z niej korzystać bezpośrednio za pomocą dedykowanych zapytań w konsoli GraphiQL lub narzędzi sieciowych.
- Rozszerzenia przeglądarki, takie jak GraphQL Network Inspector, pozwalają na bezinwazyjne podglądanie zapytań generowanych na żywo przez interfejs użytkownika (frontend) aplikacji ONE do backendu.
📚 Jak badać ruch GraphQL za pomocą GraphQL Network Inspector (Chrome)
Przeglądanie zapytań przesyłanych przez aplikację ONE web w czasie rzeczywistym jest kluczem do zrozumienia, jakich zapytań i mutacji użyć we własnych integracjach:
- Instalacja rozszerzenia: Zainstaluj rozszerzenie GraphQL Network Inspector ze sklepu Chrome Web Store.
- Uruchomienie narzędzi: Wejdź na wybraną stronę aplikacji Ataccama ONE (np. Knowledge Catalog > Catalog Items).
- Otwarcie konsoli: Otwórz Narzędzia Deweloperskie Chrome (F12 lub kliknij prawym przyciskiem myszy -> Zbadaj).
- Wybór zakładki: Kliknij ikonę rozszerzenia zakładek (
>>) w prawym górnym rogu panelu deweloperskiego i wybierz GraphQL Network. - Przechwytywanie ruchu: Odśwież stronę aplikacji Ataccama. Po lewej stronie panelu pojawi się lista wysyłanych zapytań (Queries) i mutacji (Mutations).
- Eksploracja: Wybierz dowolną pozycję z listy:
- W zakładce Request zobaczysz dokładną strukturę wysłanego zapytania wraz ze zmiennymi (Variables).
- W zakładce Response sprawdzisz dane zwrócone z serwera w formacie JSON oraz ewentualne komunikaty o błędach.
- Możesz skopiować całe zapytanie, zmienne, a nawet wyeksportować je jako polecenie cURL do wykorzystania w konsoli lub narzędziach zewnętrznych (np. ONE Desktop, GraphDev, Postman).
💡 Przykład zastosowania Jeśli chcesz dowiedzieć się, w jaki sposób aplikacja Ataccama ONE pobiera oceny jakości danych (DQ evaluations) dla danej tabeli, włącz GraphQL Network Inspector, kliknij przycisk odświeżenia DQ w aplikacji webowej i skopiuj wywołaną w tle mutację z zakładki Request.
📌 Źródła
- GraphQL Specification (Introspection schema)
- Chrome Web Store - GraphQL Network Inspector