Eksplorator API to zintegrowane z przeglądarką środowisko IDE do eksploracji GraphQL API projektu. Umożliwia deweloperom Archie Core łatwe tworzenie i wykonywanie zapytań GraphQL bezpośrednio w przestrzeni roboczej.

Eksplorator API korzysta z rzeczywistych, na żywo danych produkcyjnych.

---

Introspekcja

Schemat GraphQL ma wbudowany system introspekcji, który publikuje strukturę schematu. Dzięki temu Eksplorator API może oferować zaawansowane podpowiedzi podczas pisania zapytań GraphQL.

Będąc w bloku items, wpisz “em”. Stąd łatwo zobaczysz i wybierzesz pole email spośród dostępnych operacji w API. Podpowiedzi są kontekstowe względem miejsca w budowanym zapytaniu i filtrują opcje w zależności od wpisywanego tekstu.

Aby ręcznie otworzyć menu podpowiedzi i zobaczyć dostępne opcje, naciśnij kombinację klawiszy [Shift] + [SPACJA]. Pojawi się menu kontekstowe, w którym możesz wybrać żądane pole, np. items, z listy.

Introspekcja pomaga też wykrywać błędy w zapytaniach. System rozpoznaje, gdy typy są niedostępne lub źle skonfigurowane — np. Number powinno być String, pole niedostępne w tabeli, a także walidacje. Korzystając z Eksploratora API, najedź kursorem na czerwone faliste linie, aby zobaczyć podpowiedzi błędów.

Dostęp do dokumentacji API

Eksplorator API zawiera wbudowaną referencję schematu, która pomaga zrozumieć model danych podczas pisania zapytań. Są dwa sposoby dostępu:

1. Panel dokumentacji

Kliknij przycisk Documentation na górnym pasku narzędzi po prawej stronie. Otworzy się lewy panel boczny, w którym możesz przeglądać i wyszukiwać wszystkie dostępne Queries, Mutations i Types.

2. Kontekstowa szybka nawigacja

Jak na obrazku, możesz przejść bezpośrednio do dokumentacji konkretnego pola, które wpisujesz:

• Najedź na nazwę pola (np. cities) w edytorze. Pojawi się podpowiedź z typem zwracanym (np. CitiesConnection).
• Kliknij nazwę typu w podpowiedzi.
• Panel dokumentacji otworzy się automatycznie i przejdzie do definicji tego typu, pokazując wszystkie dostępne podpola (np. items, count, aggregates) i ich opisy.

Composer

Composer to wizualne narzędzie do budowania zapytań, zwykle domyślnie otwarte po lewej stronie Eksploratora API. Pozwala wybierać pola i argumenty, aby automatycznie generować poprawną składnię GraphQL.

Jeśli zamknąłeś panel lub go nie widzisz, możesz go ponownie otworzyć:

• Znajdź przycisk Composer na górnym pasku narzędzi po prawej.
• Jest tuż obok przycisku Documentation.
• Kliknięcie przełącza panel boczny Composer i przywraca widok edytora wizualnego.

Otwórz cities i zaznacz opcję count. Poniższe zapytanie wypełni pole tekstowe; możesz je wykonać, aby sprawdzić liczbę miast.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}