Czy kiedyś ktoś wspominał w Twoim towarzystwie o Postmanie? Zastanawiałeś się kiedykolwiek do czego służy? Jak z niego korzystać?

Jeżeli szukasz odpowiedzi na te pytania, dobrze trafiłeś. Z tego artykułu dowiesz się jak wykorzystać Postmana aby ułatwić sobie pracę przy testach API. 


Instalacja oraz kilka informacji:

Najnowszą wersję narzędzia pobierz z  oficjalnej strony https://www.getpostman.com. Wyszukaj wersję dla naszego systemu i zainstaluj. Załóż konto, (wszystkie zapisane zapytania synchronizują się w chmurze, będziesz mieć do nich dostęp zawsze i wszędzie.

Wersja PRO Postmana posiada dodatkowe funkcje, tj.: dzielenie się kolekcjami w zespole oraz odpalanie testów na wirtualnych maszynach.

W codziennej pracy wystarczająca jest wersja podstawowa.


Utworzenie konta deweloperskiego:

Do ćwiczeń wykorzystamy The New York Times API http://developer.nytimes.com. Jak pewnie się domyślasz, większość API zabezpieczona jest pewną formą autoryzacji, by chronić dostęp do zasobów przed osobami niepowołanymi. Nie inaczej jest w tym przypadku. Pierwszym krokiem powinno być utworzenie darmowego konta deweloperskiego.

image1

W tym celu po przejściu na stronę klikamy w pierwszy punkt Request an API key. Na kolejnej witrynie zobaczymy informację o danych niezbędnych do uzupełnienia by otrzymać klucz deweloperski.

image4

Po uzupełnieniu danych otrzymujemy klucz na adres e-mail (do tematu klucza powrócimy w dalszej części artykułu). Na tym etapie konieczne jest zapoznanie się z dokumentacją, aby wiedzieć jak korzystać z naszego testowego API http://developer.nytimes.com/books_api.json#/Documentation/GET/lists.%7Bformat%7D.

Pobranie informacji z API:

Po zapoznaniu się z dokumentacją możemy spróbować stworzyć nasze pierwsze zapytanie typu GET w Postmanie. Po zalogowaniu do narzędzia widzimy:

image9

Wybieramy pierwszą pozycję z lewej strony. Następnie pojawia się okno:

image6

Uzupełniamy w nim nazwę np. “Zapytanie o autora”. Następnie musimy utworzyć kolekcję, która stanowić będzie miejsce do przechowywania określonej przez Nas grupy zapytań (np. “API NYT”). Wybieramy nowo utworzoną kolekcję do zapisania naszego nowo utworzonego zapytania.

Jak pamiętamy z dokumentacji, podstawowym adresem do API jest:

image10

Kopiujemy więc adres Base URI do Postmana i wklejamy go w miejscu Enter request URL:

image3

Podmieniamy wersję API na najnowszą (w chwili pisania artykułu v3). Zapoznając się z dokumentacją NYT, możemy zauważyć, że istnieje możliwość odpytania o historyczne dane dotyczące najlepiej sprzedających się książek (zasób „lists/best-sellers/history.json”).
Chcąc wykonać takie zapytanie, musimy uszczegółowić je wprowadzając dodatkowe informacje, które przeszukają bazę danych w celu zawężenia wyników. Do omawianego przykładu użyjemy zawężenia wprowadzając zapytanie o autora książek np. Stephen King, zatem nasze zapytanie powinno wyglądać następująco:
“http://api.nytimes.com/svc/books/v3/lists/best-sellers/history.json?author=stephen king”
Obligatoryjne także jest przekazanie Twojego klucza do zakładki Headers. W kolumnie Key wpisujemy wartość api-key, natomiast w kolumnie Value kopiujemy wartość klucza, który został przesłany na adres email podany w rejestracji.
img7v2

Po uzupełnieniu danych potrzebnych do wysłania zapytania, klikamy przycisk Send.

Jeżeli podczas tego procesu otrzymałeś/aś w odpowiedzi obiekt JSON z informacją o statusie 200 oraz liście zawierającej autora Stephen King, oznacza to, że udało Ci się wysłać pierwsze poprawne zapytanie za pomocą narzędzia Postman. GRATULACJE!
image5

Zwróć uwagę na pomarańczową kropkę w lewym górnym rogu:
image11

Oznacza ona, że zmiany wprowadzone do twojego pierwszego szablonu nie zostały zapisane. Po kliknięciu Save twój szablon zostanie zapisany, dzięki czemu będziesz mógł z niego dowolnie korzystać w każdym momencie.

Skrypt automatyczny:

Oprócz wysyłania zapytań do API, w Postmanie istnieje zakładka Tests, która daje możliwość wprowadzenia skryptu za pomocą języka JavaScript. Dzięki temu możemy np. przetestować naszą odpowiedź otrzymaną z API. Wykonajmy więc prosty test odpowiedzi zwracanej z API. Korzystając z naszego poprzedniego “Zapytania o autora” wprowadzimy do zapytania test, który sprawdzi status odpowiedzi:
image2

Po wprowadzeniu skryptu testowego oraz wysłaniu zapytania, powinna się pojawić nowa zakładka (Test Results) zawierająca informację o statusie (prawda/fałsz) warunku testowego.
Spróbujmy czegoś bardziej skomplikowanego: zweryfikujmy czy odpowiedź faktycznie zwraca dzieła autorstwa Stephena Kinga:
image8

Jak możemy zauważyć nowo dodany test zakończył się powodzeniem ponieważ zwracana odpowiedź zawiera informację o dziełach Stephena Kinga, a zakładka Test Results zaktualizowała informacje o liczbie znajdujących się w niej testów.  

Dzięki możliwości wprowadzania skryptów testowych Postman staje się czymś więcej niż tylko prostym narzędziem służącym do tworzenia kolekcji i manualnego odpytywania API. Narzędzie to poprzez swoje funkcje może pozwolić nam na zautomatyzowanie weryfikacji serwisów. Korzyści płynące z wprowadzenia automatyzacji do naszych zapytań będą widoczne natychmiast, podczas wykonywania testów regresji. Tworząc odpowiednio zaprojektowane skrypty testowe, zyskujemy oszczędność czasu oraz eliminujemy możliwość powstania błędu ludzkiego.

 

Udostępnij
Czy ten artykuł był pomocny?
Tak1
Nie1