Co to jest Postman, do czego służy i jakie są jego funkcjonalności?

API w świecie tworzenia aplikacji to świetny sposób na przesyłanie i zdobywanie potrzebnych danych. Mechanizmy odpowiedzialne za udostępnianie danych w API mogą być zarówno prostymi serwisami, dzięki którym zdobędziemy kursy walut, lub przeprowadzać bardziej skomplikowane procesy, pozwalające na tworzenie użytkowników lub przetwarzające większą ilość danych. Jednak co zrobić w przypadku, gdy chcemy przetestować lub sprawdzić, jaki wynik zwróci nam odpowiednie API?

Co to jest Postman?

Postman to narzędzie, które ułatwi nam pracę z API poprzez przejrzysty graficzny interfejs. Oferuje wiele funkcjonalności, dzięki którym poza prostym wywołaniem endpointa, który jest pojedynczym adresem odpowiedzialnym za daną usługę, jesteśmy w stanie zrobić o wiele więcej, o czym wspomnimy w dalszej części tego artykułu. Postman jest używany przez ponad 500 tysięcy firm na całym świecie, a dzięki swojej popularności, oferuje stałe wsparcie i rozwija swoje usługi.

Podstawowy plan korzystania z tego narzędzia jest bezpłatny, a w jego ramach dostępne są wszystkie podstawowe funkcjonalności. Kolejne plany oparte są na miesięcznej subskrybcji i dają możliwość pracy przy bardziej zaawansowanych projektach, do których zaangażowana jest większa liczba osób.

Jak zainstalować Postmana?

Narzędzie jest dostępne w wersji desktopowej na systemy Linux, Windows i Macos oraz jako aplikacja przeglądarkowa. Ta ostatnia wersja oferuje jednak okrojone możliwości, w przeciwieństwie do pełnej wersji instalacyjnej. Aby zacząć pracę, należy założyć bezpłatne konto na stronie Postmana, a następnie pobrać odpowiednią wersję aplikacji na nasz komputer. Po poprawnej instalacji możemy już w pełni korzystać z możliwości tego narzędzia.

Jak używać Postmana? Główne funkcjonalności

Postman to idealne narzędzie do pracy przy API, które pozwoli na łatwe zarządzanie endpointami. Umożliwia tworzenie kolekcji, które grupują i porządkują wszystkie powiązane zapytania wraz z niezbędnymi danymi. W momencie gdy stworzymy potrzebne kolekcje, będziemy w stanie udostępnić je wraz w wynikami naszej pracy, innym użytkownikom w naszym zespole. Dodatkowo, dzięki wbudowanym narzędziom, jesteśmy w stanie stworzyć automatyczne testy, pozwalające na zmniejszenie liczby nieprzewidywalnych błędów.

Przyjrzyjmy się bliżej wybranym funkcjonalnościom Postmana.

Kolekcja w Postmanie

Kolekcja to grupa zapytań do API, która pozwala na ich zapisanie i użycie w przyszłości. Dobrym przykładem użycia kolekcji w celu ułatwienia naszej pracy są projekty, w których mamy zestawy endpointów, podzielonych na kategorie. Przykładowo, zestaw API obsługujących działanie sklepu, gdzie potrzebna będzie edycja, tworzenie oraz usuwanie klientów, kont, wiadomości itp. Dzięki takiemu rozwiązaniu jesteśmy w stanie stworzyć gotową strukturę zapytań oraz udostępnić naszą pracę innym.

API development

Dzięki wbudowanym narzędziom w Postmanie możemy przejść przez każdy etap budowania API. Po stworzeniu pierwszych zapytań, kolejnym krokiem jest zrobienie dokumentacji, którą dodamy przez wbudowane narzędzie w Postmanie. Pozwoli ona na łatwiejsze zrozumienie i szybsze rozpoczęcie prac przyszłym członkom zespołu.

Kolejnym atutem pracy w Postmanie jest możliwość prostego przekształcenia struktur API na działający i dostępny publicznie serwis. Umożliwia to Mock Server, dostępny w tym narzędziu, który na podstawie gotowej kolekcji tworzy gotowy serwis, zbierający wszystkie wysyłane dane.

Narzędzia do testowania API

Postman umożliwia dodawanie testów, które pozwalają na większą kontrolę nad API oraz ograniczenie niepożądanych błędów. Możemy skorzystać z gotowych rozwiązań i integracji CI np:

• CircleCI,
• Jenkins,
• Travis CI.

Drugą możliwością jest dodanie własnych testów. Prostym przykładem własnego testu może być sprawdzenie połączenia z określonym endpointem:

pm.test("Status code is 200", function () {
  pm.response.to.have.status(200);
});

Źródło: Postman Learning Center

Praca w zespole

W przypadku pracy wielu użytkowników nad jednym zestawem API, ważna jest synchronizacja pracy pomiędzy każdym z nich. Różnice w dostępnych danych mogą być problematyczne, szczególnie przy większej liczbie osób pracujących na raz. Problem ten niwelują obszary robocze dostępne w Postmanie i pozwalające na tworzenie zespołu. Po dodaniu użytkownika do naszego obszaru roboczego (workspace) i nadaniu tej osobie odpowiednich uprawnień, będzie miała ona dostęp do udostępnionych kolekcji.

Co to jest Postman? Podsumowanie

W pracy deweloperów oraz testerów jest wiele narzędzi ułatwiających codzienne obowiązki. Jednym z nich jest Postman. Pozwala na zapis API, jego testy oraz development w szybki i prosty sposób. Dodatkowo posiada możliwość synchronizacji danych z innymi użytkownikami, co przyśpiesza pracę w zespole. Dzięki swojej prostocie i regularnym wsparciu, jest jednym z lepszych dostępnych narzędzi.

Zastanawiasz się, jakie narzędzia będą najlepsze do tworzenia Twoich stron lub aplikacji? Chętnie opowiemy Ci, z jakich rozwiązań korzystamy podczas budowania dedykowanego oprogramowania.