Tester endpointu API

Opcjonalne warunki odpowiedzi

Pozostaw pole puste, aby pominąć dany warunek. Ukryty nagłówek lub nieczytelna treść odpowiedzi oznacza brak możliwości oceny, a nie niepowodzenie.

CORS decyduje, które odpowiedzi i nagłówki ta strona może odczytać. Serwer docelowy otrzymuje żądanie oraz Twój adres IP.

Status
Czas trwania
ms
Bajty
Końcowy adres URL po przekierowaniu:
Podgląd zatrzymał się na 1 MiB. Endpoint mógł zwrócić więcej danych.

Wyniki kontroli odpowiedzi

Raport z jednego żądania z pominięciem danych wrażliwych

Plik zawiera metodę, adres endpointu ograniczony do origin, końcowy status, czas i wyniki kontroli. Pomija ścieżkę i parametry URL, nagłówki i treść żądania oraz treść i wartości nagłówków odpowiedzi.

Wyślij z przeglądarki żądanie GET, HEAD, POST, PUT, PATCH lub DELETE i sprawdź końcową odpowiedź. Możesz dodać warunki dotyczące kodu statusu lub zakresu, widocznego nagłówka odpowiedzi i właściwości JSON. Każdy wybrany warunek otrzyma wynik: Spełniony, Niespełniony albo Nie można ocenić. Narzędzie pokazuje końcowy status, czas do otrzymania nagłówków, nagłówki widoczne dla przeglądarki i do 1 MiB tekstu odpowiedzi. Żądanie jest wysyłane dopiero po wybraniu przycisku Wyślij żądanie.

Jak sprawdzić endpoint API

  1. 1

    Wprowadź żądanie

    Podaj URL HTTP lub HTTPS i wybierz metodę. Jeśli endpoint tego wymaga, dodaj nagłówki żądania lub jego treść. Metody GET i HEAD nie wysyłają wprowadzonej treści.

  2. 2

    Ustaw opcjonalne warunki

    Wpisz kod, np. 200, zakres 200-204 lub grupę 2xx. Możesz też wskazać nagłówek odpowiedzi i ścieżkę JSON oraz opcjonalną oczekiwaną wartość każdego z nich. Pozostaw pole puste, aby pominąć warunek.

  3. 3

    Wyślij żądanie i odczytaj wynik

    Wybierz raz Wyślij żądanie. Sprawdź końcowy status i wynik każdego warunku. Ukryty nagłówek, nieczytelna odpowiedź lub niepełna treść JSON mogą uniemożliwić ocenę.

  4. 4

    Zapisz raport z pominięciem danych wrażliwych

    Pobierz raport tekstowy lub JSON z tej kontroli. Zawiera origin endpointu, metodę, końcowy status, czas i wyniki, ale pomija ścieżkę i parametry URL, wartości żądania oraz treść odpowiedzi.

Przykładowa kontrola odpowiedzi

Załóżmy, że Twój endpoint GET https://api.example.com/health zwraca status 200, widoczny nagłówek Content-Type: application/json i {"status":"ready"}. Możesz wpisać:

Pole opcjonalne Przykład Co sprawdza
Oczekiwane kody statusu 200, 204 lub 2xx Czy końcowy status należy do wybranego zbioru.
Nazwa nagłówka odpowiedzi Content-Type Czy przeglądarka widzi ten nagłówek.
Oczekiwana wartość nagłówka application/json Czy widoczna wartość jest dokładnie taka sama. Pozostaw puste, aby sprawdzić tylko widoczność.
Ścieżka właściwości JSON $.status Czy właściwość istnieje w pełnej odpowiedzi JSON.
Oczekiwana wartość JSON "ready" Czy odczytana wartość JSON jest zgodna. Pozostaw puste, aby sprawdzić tylko istnienie właściwości.

W polu wartości JSON stosuj składnię JSON: true oznacza wartość logiczną, 42 liczbę, a "ready" ciąg znaków. Ścieżki zaczynają się od $ i obsługują właściwości oraz indeksy tablic, np. $.data.items[0].id. Nie uruchamiają skryptów i nie obsługują filtrów. Jeśli właściwości brakuje w czytelnym dokumencie JSON, kontrola kończy się niepowodzeniem. Brakujący lub ukryty przez CORS nagłówek daje wynik Nie można ocenić, ponieważ przeglądarka nie potrafi rozróżnić tych sytuacji.

Co oznacza wynik

Wynik Znaczenie
Spełniony Czytelna końcowa odpowiedź spełnia dany warunek.
Niespełniony Czytelna końcowa odpowiedź nie spełnia warunku albo żądanej właściwości JSON brakuje.
Nie można ocenić Przeglądarka nie może ustalić wyniku, np. nie może odczytać odpowiedzi, nagłówka nie ma lub jest ukryty, albo treść JSON jest pusta, niepełna lub nieprawidłowa.

Pomiar czasu kończy się po otrzymaniu nagłówków odpowiedzi. Nie obejmuje pobrania całej treści. Limit czasu żądania wynosi 15 sekund; treść żądania może mieć do 1 MiB, a podgląd odpowiedzi kończy się po 1 MiB. Ucięty podgląd nie pozwala ocenić właściwości JSON. Odpowiedzi HEAD i 204 nie mają treści do sprawdzenia, więc wynik warunku JSON to Nie można ocenić. Narzędzie podąża za przekierowaniami i podaje końcowy URL, ale nie pokazuje każdego etapu przekierowania ani nie powtarza żądania automatycznie. Reguły CORS mogą uniemożliwić odczyt odpowiedzi przez przeglądarkę, mimo że endpoint otrzymał żądanie. Przed żądaną metodą przeglądarka może też wysłać żądanie wstępne CORS.

Można sprawdzić tylko nagłówki odpowiedzi udostępnione przeglądarce. Aby udostępnić niestandardowy nagłówek, endpoint może wymagać wpisania go w Access-Control-Expose-Headers. Nagłówek niewidoczny na tej stronie może nie istnieć na serwerze albo być ukryty przez CORS. Aby odróżnić te przypadki, sprawdź logi serwera lub użyj odpowiedniego klienta API.

Najczęściej zadawane pytania

Niespełniony oznacza, że odpowiedź czytelna dla przeglądarki nie odpowiada oczekiwaniom. Nie można ocenić oznacza brak wystarczających danych. Przeglądarka nie ustali, czy niewidocznego nagłówka nie ma, czy ukrywa go CORS, ani nie sprawdzi JSON w pustej, nieczytelnej lub uciętej treści.

Możesz podać nagłówek Authorization, jeśli endpoint zezwala na takie żądanie z przeglądarki przez CORS. Tester nie dołącza ciasteczek przeglądarki ani innych automatycznych danych uwierzytelniających. Wartość nagłówka trafia bezpośrednio do serwera docelowego, więc używaj danych dostępowych tylko z endpointem, któremu ufasz.

Przeglądarka wysyła żądanie bezpośrednio do miejsca docelowego, które otrzymuje żądanie i Twój adres IP. Wpisany adres URL, nagłówki żądania i jego treść nie przechodzą przez serwery tej witryny ani nie pojawiają się w adresie strony narzędzia. W raporcie z ukrytymi danymi pozostaje origin endpointu (protokół, domena i port), ale bez reszty URL, nagłówków żądania i jego treści. Aby przechodzić między krokami, tester na krótko zapisuje wprowadzone dane w pamięci sesji tej karty. Zapis jest przyjmowany przez najwyżej pięć minut i usuwany po odczycie, rozpoczęciu od nowa lub zakończeniu kontroli. Dopóki istnieje, mogą go odczytać skrypty tej samej witryny. Jeśli przeglądarka blokuje zapisywanie danych, możesz wysłać żądanie z tej samej strony.

Dla bieżącej kontroli powstaje jeden raport tekstowy lub JSON. Zawiera origin endpointu, metodę, końcowy status, czas do otrzymania nagłówków, liczbę przechwyconych bajtów, informację o przekierowaniu i ucięciu oraz wyniki warunków. Pomija ścieżkę, parametry i fragment URL, nagłówki żądania i ich wartości, treść żądania, nagłówki odpowiedzi i ich wartości oraz treść odpowiedzi. Przed udostępnieniem sprawdź plik, ponieważ origin i wyniki mogą nadal wskazywać Twoją usługę.

Pomiar zaczyna się tuż przed rozpoczęciem Fetch przez przeglądarkę i kończy po nadejściu nagłówków końcowej odpowiedzi. Obejmuje narzut przeglądarki i sieci oraz dozwolone przekierowania, ale nie odczyt treści. Logi serwera mogą mierzyć inny przedział.

Nie. Kontrola uruchamia się po wybraniu Wyślij żądanie. Narzędzie nie planuje, nie powtarza automatycznie ani nie monitoruje żądań. Żądania wstępne CORS i przekierowania mogą jednak wygenerować dodatkowy ruch sieciowy w ramach jednej kontroli.

Powiązane narzędzia

Narzędzie jest dostępne w innych językach