Piaskownica API
Piaskownica API to najlepsze miejsce do nauki, tworzenia i testowania zapytań GraphQL w interfejsie API platformy monday.com. Znajdziesz w niej edytor wizualny z podglądem odpowiedzi w czasie rzeczywistym, przykładowe zapytania, przeglądarkę schematu i wbudowaną pomoc AI - wszystko w przeglądarce.
Otwórz piaskownicę
Jeśli jesteś już zalogowany na konto monday.com, możesz otworzyć piaskownicę bez ponownego logowania. Jeśli nie masz jeszcze konta, najpierw utwórz bezpłatne konto deweloperskie.
- Otwórz Centrum deweloperskie (Developer Center).
- Kliknij Piaskownica API (API playground) w menu po lewej stronie.
- Zacznij testować zapytania!
Układ
Piaskownica jest podzielona na dwie sekcje:
- Lewy panel - edytor zapytań, w którym tworzysz zapytania GraphQL. Użyj kart Zmienne (Variables) i Nagłówki (Headers) u dołu edytora, aby przekazać dynamiczne wartości i niestandardowe nagłówki.
- Prawy panel - podgląd odpowiedzi z serwera, która pojawia się po wykonaniu zapytania.
Główny pasek narzędzi
Pasek narzędzi między panelami zawiera najważniejsze akcje.
Wykonaj zapytanie
Przycisk Odtwórz (Play) na środku paska narzędzi wysyła zapytanie do API. Odpowiedź pojawi się w prawym panelu.
🚧 Mutacje zmieniają rzeczywiste dane
Jeśli wywołanie API zawiera mutację, wszelkie zmiany - tworzenie, aktualizowanie lub usuwanie danych - zostaną wprowadzone w monday.com. Uważaj, aby podczas testowania nie modyfikować ani nie usuwać tablic produkcyjnych.
Uporządkuj zapytanie
Kliknij przycisk Uporządkuj (Prettify), aby automatycznie sformatować zapytanie. Poprawi wcięcia i podział na wiersze, dzięki czemu nieczytelne zapytania będą łatwiejsze do odczytania.
Kopiuj zapytanie
Przycisk Kopiuj (Copy) kopiuje bieżące zapytanie do schowka. Możesz wkleić je do kodu, dokumentacji lub wiadomości.
Wybór wersji API
Kliknij ikonę zegara, aby przełączyć wersję API. Możesz:
- Wypróbować nadchodzące funkcje w wersji kandydującej do wydania (release candidate).
- Testować starsze wersje, jeśli Twoja integracja nadal z nich korzysta.
Domyślnie piaskownica używa najnowszej stabilnej wersji.
Przykładowe zapytania
Kliknij ikonę książki na głównym pasku narzędzi, aby otworzyć bibliotekę gotowych szablonów zapytań. Znajdziesz w niej typowe operacje, takie jak pobieranie wartości kolumn i tworzenie elementów. Każdy przykład otwiera się w nowej karcie, więc nie stracisz pracy w toku.
Zapytaj Dev Sidekick
Przycisk Dev Sidekick u góry piaskownicy otwiera wbudowanego asystenta AI dla deweloperów, który zna Twoje bieżące zapytanie, zmienne i odpowiedź. Możesz poprosić go o:
- Pomoc w napisaniu zapytania lub mutacji od podstaw.
- Zdiagnozowanie błędnego żądania - lub kliknąć Napraw z AI (Fix with AI), gdy pojawi się błąd.
- Odpowiedzi na ogólne pytania dotyczące API i frameworka aplikacji.
Każda sugerowana wersja zapytania ma przycisk Zastosuj do zapytania (Apply to query), który wczytuje ją bezpośrednio do edytora.
Pobierz schemat
Przycisk w prawym górnym rogu pozwala pobrać schemat GraphQL monday.com w różnych formatach. Możesz użyć pobranego schematu w narzędziach takich jak Voyager, aby zwizualizować relacje między obiektami lub wygenerować typowane klienty API w różnych językach programowania.
Schemat możesz też pobrać programowo. Informacje o dostępnych punktach końcowych i formatach znajdziesz w przeglądzie GraphQL.
Lewy panel boczny
Lewy panel boczny zawiera narzędzia do przeglądania API i zarządzania pracą.
Przeglądarka schematu
Ikona książki otwiera przeglądarkę schematu, w której możesz sprawdzić wszystkie dostępne pola, ich typy, argumenty oraz to, czy mogą przyjmować wartość null. To szybki sposób na sprawdzenie struktury dowolnego obiektu bez opuszczania piaskownicy.
Historia
Przycisk historii zapisuje każde wykonane zapytanie. Możesz w dowolnym momencie wrócić do wcześniejszego zapytania - nawet jeśli od tego czasu je nadpisałeś lub popełniłeś błędy.
Skróty klawiszowe
Menu skrótów zawiera wszystkie dostępne skróty klawiszowe. Szczególnie przydatny jest skrót ⌘K (Mac) / Ctrl+K (Windows). Otwiera podpowiedzi automatycznego uzupełniania w wierszu, dzięki którym możesz przeglądać dostępne pola i atrybuty bezpośrednio w edytorze.
Konfiguracja
Menu konfiguracji pozwala przełączać się między trybem ciemnym i trybem jasnym.
Publiczna piaskownica
Publiczna piaskownica udostępnia część opisanych wyżej funkcji i wymaga ręcznego uwierzytelnienia. Przyda się, jeśli masz token API, ale nie możesz zalogować się do interfejsu konta.
- Otwórz publiczną piaskownicę.
- Pobierz token API i wklej go w oknie modalnym.
- Zacznij testować zapytania!
