Przewodnik po programie Postman: czym jest, dlaczego jest potrzebny i jak go używać

Spis treści:

• Co to jest Postman i dlaczego jest potrzebny
• Jak działa Postman
• Jak korzystać z Postmana
• Podsumowanie

Współczesna sieć WWW w dużej mierze opiera się na wykorzystaniu interfejsów API, a niemal każdy backend wymaga obecności interfejsów programistycznych. Pomimo łatwości pracy z interfejsami API, pojawiają się pewne trudności: konieczne jest opracowanie architektury i logiki, stworzenie wysokiej jakości dokumentacji, przeprowadzenie testów i zapewnienie skalowalności interfejsu. Efektywne zarządzanie interfejsami API ma kluczowe znaczenie dla prawidłowego funkcjonowania aplikacji internetowych, ponieważ bezpośrednio wpływa na ich wydajność i komfort użytkowania. Istnieje wiele usług, które ułatwiają pracę z interfejsami API, a jedną z najpopularniejszych jest Postman. Choć często postrzegana wyłącznie jako narzędzie do testowania interfejsów API, platforma ta oferuje znacznie więcej funkcjonalności. Postman oferuje rozbudowane możliwości tworzenia, dokumentowania i monitorowania interfejsów API, co czyni go niezbędnym narzędziem dla programistów i zespołów zajmujących się integracjami. Korzystanie z Postmana pozwala nie tylko testować interfejsy API, ale także automatyzować procesy, tworzyć zestawy testów i zarządzać żądaniami, co ostatecznie zwiększa wydajność rozwoju i jakość produktu.

Czym jest Postman i dlaczego go potrzebujesz?

Postman to potężne narzędzie przeznaczone do tworzenia, testowania i dokumentowania interfejsów API. Za jego pomocą użytkownicy mogą tworzyć zbiory żądań do różnych interfejsów API, konfigurować środowiska i używać serwerów pozorowanych do symulowania działania interfejsu API. Postman umożliwia również pisanie zautomatyzowanych testów w JavaScript, co upraszcza proces weryfikacji funkcjonalności interfejsu API. Ponadto usługa zapewnia możliwość analizy i wizualizacji wyników żądań, co czyni ją niezastąpioną w procesie tworzenia i utrzymywania interfejsów API. Korzystanie z Postmana pomaga zwiększyć wydajność pracy z interfejsami API i poprawić jakość tworzonego oprogramowania.

Program obsługuje różne architektury API, w tym HTTP, REST, SOAP, GraphQL i WebSockets. Postman jest aktywnie wykorzystywany przez firmy takie jak Twitter, WhatsApp i Imgur. Przyjazny dla użytkownika interfejs graficzny ułatwia nawet początkującym opanowanie platformy i efektywną pracę z interfejsami API.

Postman jest dostępny bezpłatnie na oficjalnej stronie internetowej. Dostępne są wersje dla systemów Linux, Windows i macOS. Uwaga: aby zacząć korzystać z programu, należy się zarejestrować. Postman to niezbędne narzędzie dla programistów, umożliwiające testowanie interfejsów API i uproszczenie procesu tworzenia oprogramowania.

Jak działa Postman

Podstawowym elementem Postmana jest obszar roboczy. Wersja darmowa oferuje trzy typy obszarów roboczych: osobisty, współdzielony i zespołowy. Każdy z tych typów obszarów roboczych jest przeznaczony do różnych zastosowań i pomaga usprawnić proces tworzenia interfejsów API. Osobista przestrzeń robocza nadaje się do indywidualnej pracy nad projektami, współdzielona przestrzeń robocza zapewnia grupowy dostęp do kolekcji i dokumentacji, a przestrzeń robocza zespołowa służy do zarządzania projektami w zespole, gdzie można udostępniać zasoby i współpracować.

• Prywatna – widoczna tylko dla właściciela;
• Zespół – widoczna tylko dla członków zespołu, którzy w niej pracują;
• Publiczna – dostępna dla wszystkich.

Wersja Pro zapewnia dostęp do prywatnych przestrzeni roboczych. Przestrzenie te są dostępne tylko dla zaproszonych uczestników, co zapewnia wysoki poziom prywatności i kontroli nad projektami. Wersja Enterprise rozszerza swoją funkcjonalność, dodając przestrzenie robocze partnerów. Są one widoczne nie tylko dla członków zespołu, ale także dla zaproszonych partnerów, co sprzyja efektywniejszej współpracy między różnymi interesariuszami.

Przestrzeń robocza Postman to zintegrowane środowisko, w którym użytkownicy mogą tworzyć, testować i dokumentować interfejsy API. Głównymi komponentami przestrzeni roboczej są kolekcje, środowiska i zapytania. Kolekcje umożliwiają organizowanie zestawów żądań, które można zapisywać i udostępniać innym użytkownikom. Środowiska umożliwiają zarządzanie zmiennymi, upraszczając pracę z różnymi interfejsami API i ich parametrami. Żądania stanowią podstawę pracy z interfejsami API, umożliwiając wysyłanie danych do serwera i odbieranie odpowiedzi. Postman oferuje również narzędzia do automatycznego testowania i monitorowania wydajności API, co czyni go niezbędnym narzędziem dla programistów i testerów. Prawidłowa organizacja przestrzeni roboczej w programie Postman przyczynia się do zwiększenia wydajności i poprawy jakości interfejsu API.

Lewy pasek boczny jest kluczowym elementem Interfejs Postmana oferuje siedem zakładek, z których każda odpowiada głównym narzędziom aplikacji. Zakładki te upraszczają nawigację i pozwalają użytkownikom efektywnie korzystać z API, testować zapytania i zarządzać kolekcjami.

• Kolekcje. To miejsce, w którym przechowywane są kolekcje żądań API. Wiele żądań w ramach jednej kolekcji można łączyć w foldery.
• Interfejsy API. Ta zakładka umożliwia przechowywanie całych interfejsów API: ich definicji i kolekcji.
• Środowiska. To miejsce, w którym tworzone i przechowywane są środowiska, w których przechowywane są zmienne. Aktywne środowisko można zmienić z dowolnej zakładki w prawym górnym rogu (tam, gdzie na zrzucie ekranu widnieje napis „Brak środowiska”). Można tu również tworzyć zmienne globalne, których można używać w dowolnym miejscu, niezależnie od środowiska.
• Serwery pozorowane. To miejsce umożliwia tworzenie serwerów pozorowanych, które symulują działanie rzeczywistych serwerów. Jest to przydatne podczas testowania.
• Monitory. Monitory umożliwiają wizualizację i monitorowanie wydajności API: śledzenie wydajności, sprawdzanie dostępności serwera i jego poprawnego działania zgodnie z harmonogramem oraz wysyłanie powiadomień o awariach.
• Przepływy. To narzędzie umożliwia konfigurowanie logiki aplikacji API w edytorze wizualnym. Od marca 2023 r. jest on nadal dostępny tylko w trybie testowym; aby z niego skorzystać, należy wysłać żądanie.
• Historia. To tutaj przechowywana jest historia wszystkich wysłanych żądań. Można je zapisywać, łączyć w kolekcje, a także tworzyć dla nich dokumentację, monitory i serwery testowe.

Jak korzystać z Postmana

Postman to jedno z najpopularniejszych narzędzi w dziedzinie testowania API. Umożliwia programistom i testerom łatwe tworzenie żądań do dowolnych interfejsów API, nawet jeśli wcześniej nie korzystali z Postmana do ich tworzenia. Dzięki intuicyjnemu interfejsowi i rozbudowanej funkcjonalności Postman upraszcza proces testowania i debugowania API, czyniąc go niezbędnym narzędziem w arsenale każdego specjalisty.

Platforma oferuje własne API, które pozwala użytkownikom testować funkcjonalność usługi i badać działanie żądań. Serwer echo zwraca klientowi te same dane, które zostały wysłane. Aby uzyskać więcej informacji o działaniu API, zapoznaj się z dokumentacją.

Utwórzmy własne żądanie API i przetestujmy jego funkcjonalność. To pozwoli nam lepiej zrozumieć, jak wchodzić w interakcję z API i wykorzystywać jego możliwości do pobierania potrzebnych danych. Omówimy podstawowe kroki wymagane do pomyślnego wysłania żądania i otrzymania odpowiedzi z serwera. Korzystając z odpowiednich narzędzi i bibliotek, możemy uprościć proces pracy z API i zoptymalizować go pod kątem naszych potrzeb.

Aby utworzyć nową kolekcję, przejdź do zakładki Kolekcje i kliknij przycisk + w górnym rogu. Następnie po lewej stronie aplikacji pojawi się element „Nowa kolekcja”, za pomocą którego możesz rozpocząć proces tworzenia kolekcji.

Aby zmienić nazwę kolekcji testowej, kliknij trzy kropki po prawej stronie Nowej kolekcji. W wyświetlonym menu wybierz opcję Zmień nazwę.

Obszar roboczy kolekcji zawiera pięć kart, z których każda pełni swoją własną, unikalną funkcję. Te zakładki zapewniają wygodny dostęp do różnych aspektów zarządzania zbiorem, umożliwiając użytkownikom efektywne organizowanie i analizowanie danych. Co ważne, każda zakładka oferuje specjalistyczne narzędzia i informacje, pomagając usprawnić przepływ pracy. Użytkownicy mogą łatwo przełączać się między zakładkami, co znacznie upraszcza interakcję z zbiorem i zwiększa produktywność.

• Autoryzacja. Tutaj możesz skonfigurować metodę autoryzacji i parametry, które będą używane w każdym żądaniu w ramach kolekcji.
• Skrypt przed żądaniem. Tutaj możesz napisać program JavaScript, który będzie wykonywany przed każdym żądaniem w ramach kolekcji. Dla najpopularniejszych algorytmów Postman oferuje gotowe fragmenty kodu. Możesz ich użyć, aby uniknąć pisania kodu od podstaw.
• Testy. Działa jak Skrypt przed żądaniem, ale wykonuje kod po wysłaniu żądania. To sekcja używana przez testerów do sprawdzania API. Gotowe fragmenty kodu są również dostępne tutaj.
• Zmienne. Tutaj możesz utworzyć zmienną i przypisać jej wartość. Możesz następnie użyć tej zmiennej, podając jej nazwę w podwójnych nawiasach klamrowych {{nazwa zmiennej}}.
• Uruchomienia. Postman pozwala uruchamiać żądania nie pojedynczo, ale wszystkie naraz – w ramach jednej kolekcji lub folderu. Sekcja Uruchomienia przechowuje informacje o takich uruchomieniach i ich wynikach testów.

Istnieją różne sposoby utworzenia żądania. Możesz skorzystać z formularza na stronie internetowej, wysłać e-mail lub zadzwonić. Każda z tych metod zapewnia wygodny sposób komunikacji i pozwala uzyskać potrzebne informacje. Wybór odpowiedniej metody zależy od Twoich preferencji i pilności żądania. Skontaktuj się z nami, a postaramy się odpowiedzieć na Twoje pytanie tak szybko, jak to możliwe.

• kliknij przycisk „Nowy” w lewym górnym rogu i wybierz żądany typ żądania;
• kliknij plus na pasku kart u góry aplikacji;
• kliknij trzy kropki obok nazwy kolekcji i wybierz „Dodaj żądanie” z menu podręcznego.

Wybierając pierwszą lub drugą metodę zapisywania żądania, należy określić kolekcję, w której zostanie ono zapisane. Pozwoli to na sprawną organizację danych i uproszczenie ich późniejszego wykorzystania.

Utwórzmy żądanie GET do adresu https://postman-echo.com i nazwijmy je „Test GET”. Nazwy żądań można zmieniać w taki sam sposób, jak nazwy kolekcji. Aby to zrobić, otwórz interfejs Postmana, wybierz metodę GET i wprowadź określony adres URL. Następnie możesz przetestować żądanie, aby upewnić się, że działa poprawnie i zwraca oczekiwane rezultaty. Dostosowanie nagłówków i parametrów, jeśli to konieczne, pozwoli na dokładniejszą kontrolę nad żądaniem.

• Utwórzmy nowe żądanie.
• Wybierz metodę GET.
• Wprowadź adres URL: https://postman-echo.com/get/.
• W sekcji Parametry wprowadź odpowiednio klucze test_key1, test_key2 i wartości test_value1, test_value2.
• Kliknij przycisk Wyślij.

Serwer echo odpowiedział plikiem JSON zawierającym nagłówki i argumenty, które mu przekazaliśmy. Niektóre nagłówki są dodawane automatycznie przez Postmana. Ten proces pozwala na efektywne testowanie interfejsu API i weryfikację poprawności przesyłanych danych.

Po otrzymaniu odpowiedzi w Postmanie można dodatkowo wyświetlić pliki cookie, nagłówki i wyniki testów, jeśli takie istnieją. Postman udostępnia również informacje o statusie odpowiedzi, czasie otrzymania i rozmiarze zwróconego pliku, umożliwiając szczegółową analizę wyników żądań.

W żądaniach Postmana, podobnie jak w kolekcjach, można określić metodę, parametry autoryzacji oraz używać skryptów i testów przed żądaniem. Pozwala to na efektywne zarządzanie żądaniami API, automatyzację procesów i weryfikację odpowiedzi serwera. Ustawienie prawidłowej metody autoryzacji i parametrów zapewnia poprawną interakcję z API, a skrypty i testy przed żądaniem pozwalają na weryfikację funkcjonalności i wydajności żądań. Prawidłowa konfiguracja tych elementów w Postmanie znacząco usprawnia przepływ pracy i umożliwia efektywniejsze testowanie API.

Domyślnie autoryzacja jest dziedziczona z kolekcji, ale można ją zmodyfikować dla konkretnego żądania. Skrypty są wykonywane w całości, zarówno w obrębie kolekcji, jak i dla konkretnego żądania. Pozwala to na elastyczne zarządzanie dostępem i funkcjonalnością, zapewniając niezbędne bezpieczeństwo i możliwość personalizacji przetwarzania danych.

Teraz utwórzmy prosty test dla naszego żądania GET, który sprawdzi kod odpowiedzi. Jeśli kod odpowiedzi wynosi 200, oznacza to, że żądanie zakończyło się powodzeniem i test uznaje się za zaliczony.

Najpierw otwórz kartę Testy i w prawej kolumnie znajdź fragment kodu z tekstem Kod statusu: Kod wynosi 200. Kliknij go, a skrypt się otworzy.

Teraz powtórzmy żądanie. W polu odpowiedzi na karcie Wyniki testów zostanie wyświetlony raport z testu: PASS, co oznacza, że ​​test został pomyślnie zaliczony.

Teraz utworzymy dwa testy, które będą znajdować się w tej samej kolekcji. Pierwszy test sprawdzi obecność ciągu „test_value2” w treści odpowiedzi, a drugi sprawdzi obecność ciągu „string_you_want_to_search”. Przejdźmy do sekcji „Kolekcja testów” i otwórzmy kartę „Testy”. Wybierz fragment kodu „Treść odpowiedzi: Zawiera ciąg” i kliknij go dwukrotnie. W pierwszym bloku kodu zastąp ciąg „string_you_want_to_search” ciągiem „test_value2” i pozostaw drugi blok bez zmian. Pamiętaj o zapisaniu zmian, aby nowe testy zostały zastosowane do żądania. Pomoże to zapewnić prawidłowe wykonywanie testów i poprawić jakość walidacji odpowiedzi serwera.

Teraz wyślijmy to samo żądanie GET do serwera echo. Powinien przejść pierwszy test, ponieważ przekazaliśmy test_value2 jako jeden z parametrów. Jednak drugi test powinien zakończyć się niepowodzeniem. Przeanalizujmy uzyskany wynik.

Zgodnie z oczekiwaniami, do żądania zastosowano zarówno własne testy, jak i testy całej kolekcji. Jeden z testów kolekcji zakończył się niepowodzeniem. W tym przypadku testy kolekcji zostały wykonane jako pierwsze, przed testami samego żądania.

Kolejność wykonywania skryptów umieszczonych w różnych częściach kolekcji jest określona w następujący sposób:

• Najpierw wykonywane są skrypty kolekcji.
• Następnie skrypty folderów (mogą być tam również zapisane).
• I dopiero potem skrypty żądań.

Ta metoda ma zastosowanie do dowolnego kodu, zarówno w sekcji Tests, jak i w Pre-request Scripts.

Zmienne i testy w Postmanie znajdują się na różnych poziomach i mogą być tworzone w różnych miejscach. Pozwala to na elastyczne zarządzanie danymi i skryptami testowymi, zapewniając efektywną interakcję z API. Można używać zmiennych globalnych, zmiennych kolekcji i zmiennych środowiskowych, co daje możliwość dostosowania testów do konkretnych warunków. Optymalne wykorzystanie zmiennych nie tylko upraszcza proces testowania, ale także zwiększa jego wydajność.

• Zmienne globalne mają zastosowanie do całego obszaru roboczego. Można je zapisać na karcie Środowiska, w sekcji Zmienne globalne.
• Zmienne kolekcji są tworzone w obrębie określonej kolekcji i działają tylko w jej obrębie.
• Zmienne środowiskowe są ustawiane na poziomie środowiska na karcie Środowiska. Aby zastosować je do żądania, należy je bezpośrednio powiązać ze środowiskiem.
• Zmienne lokalne istnieją na poziomie skryptów wykonywanych podczas wysyłania żądań.
• Zmienne danych pojawiają się, gdy używamy narzędzia Collection Runner – narzędzia do jednoczesnego uruchamiania wszystkich skryptów w kolekcji lub folderze.

Zakres zmiennej odgrywa kluczową rolę w określaniu jej priorytetu. Im węższy zakres, tym wyższy priorytet zmiennej. Oznacza to, że jeśli w kodzie znajdują się zmienne globalne i lokalne o tej samej nazwie, zostanie użyta wartość zmiennej lokalnej. Zrozumienie tej zasady jest ważnym aspektem programowania, ponieważ pomaga uniknąć nieoczekiwanych błędów i konfliktów w kodzie.

Tworzenie nowego środowiska testowego jest podobne do tworzenia kolekcji, ale w tym przypadku należy przejść do zakładki „Środowisko”.

Utwórzmy zmienną o nazwie test_variable i przypiszemy jej wartość test_value3. Następnie zapisz zmiany wprowadzone w bieżącym środowisku.

Przejdźmy teraz do kolekcji testowej i skonfigurujmy środowisko, wybierając je w prawym górnym rogu. Następnie będziemy mogli używać wszystkich zmiennych środowiskowych w tej kolekcji. Pozwoli nam to skutecznie zarządzać parametrami i usprawnić proces testowania.

Ulepszmy drugi skrypt w testach kolekcji. Aby to zrobić, zamień ciąg „string_you_want_to_search” na fragment „Pobierz zmienną środowiskową”. W tym fragmencie zmień zmienną „variable_key” na nazwę zmiennej „test_variable”. Po wprowadzeniu zmian koniecznie zapisz plik. Zapewni to poprawne działanie skryptu i efektywne wykorzystanie zmiennych środowiskowych w testach.

Drugi skrypt sprawdzi, czy odpowiedź serwera jest zgodna z zawartością zmiennej „test_variable”, a nie ze stałym ciągiem „string_you_want_to_search”. Dzięki temu sprawdzanie jest bardziej elastyczne i dostosowuje się do zmieniających się danych, co poprawia wydajność interakcji z serwerem.

Teraz przyjrzyjmy się Żądanie GET i dodanie nowego parametru. Kluczem tego parametru będzie test_key3, a wartością zawartość zmiennej test_variable. Aby użyć zmiennej, należy ująć jej nazwę w podwójne nawiasy klamrowe {{}}. Po wprowadzeniu zmian nie zapomnij ich zapisać i wysłać zgłoszenia.

Wszystkie testy zakończyły się pomyślnie. Potwierdza to, że wartość naszej zmiennej jest poprawnie pobierana zarówno z parametrów żądania, jak i podczas testowania.

Do Podsumowanie

Postman to potężne narzędzie do pracy z interfejsami API na wszystkich etapach ich cyklu życia. Jest szczególnie popularny wśród testerów ze względu na rozbudowane możliwości tworzenia i dostosowywania żądań. Postman umożliwia tworzenie żądań, organizowanie ich w kolekcje i foldery oraz korzystanie z różnych środowisk z niestandardowymi zmiennymi. Ponadto narzędzie umożliwia tworzenie zautomatyzowanych testów, znacznie upraszczając proces testowania API i zwiększając jego wydajność.

Postman oferuje płatne plany, ale wersja darmowa jest odpowiednia na początek, do projektów osobistych i testowania API. Ta opcja pozwala zapoznać się z podstawowymi funkcjami i narzędziami potrzebnymi do efektywnej pracy z interfejsami API bez ponoszenia dodatkowych kosztów. Darmowa wersja Postmana jest idealna dla programistów, którzy chcą przetestować swoje pomysły i projekty przed przejściem na plan płatny.

Dowiedz się więcej o kodowaniu i programowaniu na naszym kanale Telegram. Subskrybuj nas, aby być na bieżąco z nowościami i otrzymywać przydatne wskazówki!

Sprawdź dodatkowe materiały:

• Ból testera: Z jakimi problemami borykają się inżynierowie QA
• Test: Zgadnij, gdzie są ezoteryczne języki programowania, a gdzie nie
• Co to jest API i jak działa?