Skrzynka pocztowa

Postman, a po co to komu?

W ostatnim poście krótko wspomniałem o postmanie, dziś będzie więcej. Jak go używam, po co go używam, jakie możliwości znam? Jeśli tworzysz API i zastanawiasz się, jak testować swoje endpointy to jest to artykuł dla Ciebie 😊

Postman jest bezpłatnym narzędziem, które możemy wykorzystać do testów API. Jest to narzędzie intuicyjne i proste w obsłudze oraz o całkiem sporych możliwościach. Program jest do pobrania tu: https://www.getpostman.com/ . Po zainstalowaniu jest gotowy do użycia. Możesz użyć dowolnego API, to ze screena to jakieś z fake-owymi danymi.

postman parametry requestu

  1. Wybierz typ requestu, który chcesz wykonać
  2. Podaj link do odpowiedniego API endpointu.
  3. Po kliknięciu, możesz dodać parametry do linku jako klucz-wartość.
  4. Możesz wybrać typ autoryzacji i podać token autoryzacyjny, jeśli trzeba.
  5. Tu dodajemy inne headery do naszego zapytania, np. to aby zwrot był w formacie JSON 😊

A tu mamy rezultat tego zapytania:

Postman response

  1. Kod jaki zwrócił serwer, po więcej odsyłam tu: https://pl.wikipedia.org/wiki/Kod_odpowiedzi_HTTP Jednak z grubsza kody przedstawiają się tak:

 kody html

  1. Czas wykonania zapytania.
  2. Odpowiedź serwera (polecam używać JSON-a, najlepiej się prezentuje)
  3. Ciastka i nagłówki, które zwrócił serwer.

Jak widzisz, używanie tego narzędzia jest całkiem proste, ale to nie wszystko, co możemy zrobić w postmanie. Prawdziwa siła zaczyna się w zakładce „Collections”. Tam możemy stworzyć nowy projekt i pogrupować go w foldery, np. folder z wszystkimi możliwymi requestami do userów, wszystkie do postów itp.

 Postman Foldery

Logując się na nasze konto, projekty będą się automatycznie synchronizować, gdy pracujemy np. na kilku maszynach.

A co, jeśli pracujemy z kilkoma osobami i każda ma swoje konta?

Wtedy bardzo przydatny jest export całego projektu:

export projektu

Pracowałem w ten sposób w kilka osób i po tym, jak wyrobiliśmy w sobie nawyk zaciągania nowej wersji JSON-a z GitHuba przed rozpoczęciem pracy z postmanem było już całkiem przyjemnie 😊

To jeszcze nie wszystko co chciałem Ci pokazać. W postmanie można także zdefiniować środowiska i zmienne. Jest to bardzo przydatne, gdy chcemy nasze endpointy testować na kilku środowiskach.

zarządzanie środowiskami

 

Tworzymy zatem środowisko Dev i stage (i jakie tam jeszcze mamy) w zakładce „manage envirnoments”.

Zmienna w środowisku

Teraz mamy listę dostępnych środowisk wraz z zdefiniowaną jedną zmienną o dokładnie takiej samej nazwie w obu środowiskach.

lista środowisk

 

Aby użyć naszej zmiennej (w tym wypadku domeny), w linku wpisujemy nazwę zmiennej w podwójnych nawiasach klamrowych {{nazwa}}. Wybieramy środowisko z rozwijanej listy i postman będzie podmieniał zmienną na wartość zdefiniowaną w środowisku.

request z zmiennymi

 

Środowiska również możemy eksportować i wyeksportowane JSON-y wrzucać do repozytorium tak, by cały team miał do nich dostęp.

Postman ma z pewnością jeszcze sporo do zaoferowania poza tym co pokazałem, ale to są rzeczy, które mnie do niego przekonały, i których ja używałem za każdym razem, gdy z niego korzystałem. A czego Ty używasz do testowania endpointów? 😊

Pozdrawiam, Kamil.

Data publikacji: 13.08.2017 Ostatnie z kategorii: