Klienty GraphQL

Jest to zestawienie i przegląd niektórych z najpopularniejszych klientów do interakcji z GraphQL.

​

GraphiQL

GraphiQL to IDE par excellence do wykonywania queries GraphQL. Wydany początkowo razem z GraphQL, od razu pokazał, jak GraphQL może oferować doświadczenie deweloperskie przewyższające istniejące API, łącząc w jednym miejscu klienta do wykonywania queries względem serwera GraphQL oraz eksploratora do przeglądania dokumentacji schematu.

GraphiQL oferuje między innymi następujące funkcje:

• Zakładki
• Niestandardowe nagłówki
• Podświetlanie składni
• Inteligentne podpowiadanie pól, argumentów, typów i nie tylko
• Podświetlanie i raportowanie błędów w czasie rzeczywistym dla queries i zmiennych
• Automatyczne uzupełnianie queries i zmiennych
• Automatyczne dodawanie wymaganych pól do queries
• Eksplorator dokumentacji z wyszukiwaniem i obsługą Markdown
• Historia queries z wykorzystaniem lokalnego magazynu danych
• Motywy

Demo jest dostępne pod adresem graphql.org/swapi-graphql. Utwórz query GraphQL za pomocą edytora, naciśnij przycisk "Execute Query" pośrodku między dwoma panelami i obserwuj odpowiedź na query.

​

Voyager

GraphQL Voyager to kwintesencja interaktywnego wizualizatora schematów, pokazującego (jak wspomniano w jego dokumentacji) "graf stojący za GraphQL".

Oferuje następujące funkcje:

• Szybka nawigacja po grafie.
• Lewy panel dostarczający szczegółowych informacji o każdym typie.
• Opcja "Skip Relay" upraszczająca graf przez usunięcie klas opakowujących Relay.
• Możliwość wyboru dowolnego typu jako korzenia grafu.

Demo na żywo jest dostępne pod adresem ivangoncharov.github.io/graphql-voyager.

​

DociQL

DociQL udostępnia polecenie do generowania pięknej statycznej dokumentacji HTML5 z punktu końcowego GraphQL. Po uruchomieniu polecenia wynikiem będzie katalog zawierający pliki HTML, CSS i JS, które należy skopiować na serwer WWW, aby wyświetlić dokumentację schematu GraphQL.

Wygenerowana dokumentacja domyślnie wyświetla układ jednostronicowy z 3 kolumnami: linki do wszystkich typów w lewej kolumnie, opis w środku i przykładowe query po prawej:

Oferuje następujące funkcje:

• Używa introspection query do pobrania schematu GraphQL i dynamicznego generowania dokumentacji.
• Generuje przykładowe żądanie i odpowiedź z linkami "Try it now".
• Pozwala użytkownikowi definiować przypadki użycia i grupować je według domeny.
• Konfigurowalny za pomocą szablonów Handlebars i stylów SCSS.
• Obsługa Markdown w opisach API.
• Responsywny układ HTML5 i CSS3 działający na wszystkich urządzeniach i rozmiarach ekranu.
• Częściowa dokumentacja, możliwa do osadzenia w istniejącej witrynie.

Demo wygenerowanej dokumentacji jest dostępne pod adresem wayfair.github.io/dociql.

​

SpectaQL

SpectaQL rozbudowuje DociQL, aby lepiej dostosować go do GraphQL. Zapewnia motyw wyświetlający tylko informacje istotne dla GraphQL, usuwając treści z domeny Swagger/OpenAPI (na przykład odrzuca komunikaty "Response Content-Types: application/json" i "Response Example (200 OK)" widoczne w przykładzie query).

SpectaQL pozwala również wprowadzać źródło schematu GraphQL na kilka sposobów:

• Z aktywnego punktu końcowego przy użyciu introspection query.
• Z pliku zawierającego wynik introspection query.
• Z pliku, wielu plików lub globa wskazującego na definicje schematu w SDL.

Demo wygenerowanej dokumentacji jest dostępne pod adresem useanvil.com/docs/api/graphql/reference.

​

Postman

Postman to platforma API do tworzenia i korzystania z API. Choć nie został stworzony specjalnie dla GraphQL, Postman może być używany do wykonywania queries GraphQL i usprawniania współpracy przy tworzeniu API GraphQL.

Postman zawiera narzędzia pomagające przyspieszyć cykl życia API, w tym projektowanie, testowanie, dokumentację i mockowanie API. Możemy organizować API za pomocą przestrzeni roboczych, aby współpracować z członkami zespołu rozproszonymi po całym świecie.

​

Altair

Altair to kolejne IDE klienta GraphQL, podobne do Postmana, ale dedykowane dla GraphQL.

Oprócz wszystkich funkcji oferowanych przez każde IDE klienta GraphQL, Altair oferuje również środowiska, dzięki którym możemy przełączać się między używaniem API dla środowisk lokalnych, stagingowych i produkcyjnych, oraz kolekcje queries, które można łatwo udostępniać członkom zespołu.