⛏ Testowanie REST API dla początkujących – praktyczny przewodnik krok po kroku jak zacząć i co musisz wiedzieć ⛏

---

1. Wstęp 🏠

Testowanie REST API w wielu projektach staje się kluczowym element zapewniania jakości oprogramowania. Dzięki dobrze przeprowadzonym testom API, testerzy mogą wcześnie wykryć błędy, zapobiec poważnym awariom i znacząco usprawnić działanie całych systemów. Testowanie API może być również dla wielu testerów kolejnym krokiem w rozwoju kariery, ponieważ jest to jedna z często wymaganych umiejętności na bardziej zaawansowanych stanowiskach testerskich. Pytania z testowania API zdażają sie również na rekrutacjach na poziomie juniorskim. Umiejętność testowania API pozwala testerom na bliską współpracę z developerami oraz analitykami, którą mogą rozpoczać jeszcze przed zakończeniem pracy nad frontendem aplikacji. Dlatego też uzupełnienie CV o umiejętność testowania API powinna być w planie każdego chcącego sie rozwijać testera.

2. Czym Jest API ❓

Rozszyfrujmy na początku tytułowy skrót API. Application Programming Interface jest to interfejs, który pozwala aplikacjom na wymianę danych między sobą. REST API (Representational State Transfer API) to jeden z najpopularniejszych typów architektury API, który komunikuje się przez protokół HTTP i operuje na zasobach przy pomocy standardowych metod.

Najczęściej API kojarzone jest z serwisami webowymi a w szczególności z architekturą mikroserwisów. W architekturze tej nie tworzymy dużych monolitycznych aplikacji backendowych a wiele mniejszych (serwisów webowych, mikroforntendów itd.), które odpowiadają za konkretne operacje i które komunikują się ze sobą.

API wykorzystywane jest najczęściej w dwóch przypadkach:

• Komunikacja Frontend Aplikacji - Serwis: W tym przypadku frontend aplikacji wykorzystujący najczęściej biblioteki dedykowane dla danego języka komunikuje się z backendem aplikacji (serwisem) w celu pobrania danych oraz wykonaniu na nich operacji zleconych przez użytkownika.
• Komunikacja Serwis - Serwis: W tym przypadku serwisy komunikują się między sobą w celu przetwarzania danych. Mogą je grupować, filtrować, przetwarzać zgodnie z oczekiwaniami systemu.

Warto jeszcze wspomnieć fakt że w komunikacji opartej o REST API wykorzystuje się przedewszystkim format JSON, o którym jeszcze powiemy więcej w dalszej części artykułu.

Należy również pamiętać że REST API to nie jedyna metoda kominikacji pomiedzy aplikacjami jednak biorąć pod uwagę jej popularność można uznać ja obecnie za najpopularniejszą i dominującą.

3. Czym Są Testy API ❓

Testy API to rodzaj testów, które sprawdzają poprawność, bezpieczeństwo, wydajność oraz funkcjonalność serwisów webowych (ang. WebServices) wspierających komunikację popzez API. Polegają na wysyłaniu żądań HTTP do API i weryfikacji otrzymywanych odpowiedzi. Celem jest upewnienie się, że API działa zgodnie ze specyfikacją, jest dostępne i poprawnie przetwarza dane.

Testowanie API obejmuje m.in.:

• Testy funkcjonalne: Sprawdzają, czy API spełnia wymagania biznesowe oraz prawidłowo realizuje wszystkie funkcjonalności.
• Testy wydajnościowe: Mają na celu sprawdzenie, jak API radzi sobie z dużą ilością żądań i czy czas odpowiedzi jest akceptowalny.
• Testy bezpieczeństwa: Upewniają się, że API jest odporne na potencjalne ataki i nie udostępnia nieuprawnionych danych.
• Testy integracyjne: Sprawdzają komunikację pomiędzy różnymi serwisami i systemami w kontekście użycia API.

Jedną z najważniejszych zalet testów API jest możliwość wczesnego wykrycia błędów przed włączeniem pełnej integracji z innymi elementami systemu. Pozwala to na szybkie odnajdywanie i rozwiązywanie błędów najczęściej w bliskiej współpracy z deweloperem.

Mówiąc o testach API często podkreśla się żę są one szybsze i jest to bardziej wydajny sposób testowania niż manualne testy za pośrednictwem interfejsu użytkownika. Stwierdzenie to może być prawdziwe ale tylko pod pewnymi warunkami i zakładająć znaczną sprawność testera w ich wykonywaniu.

Warto zaznaczyć że testy API świetnie sprawdzają sie jako obiekt przeznaczony do automatyzacji i wielokrotnego ich wykorzystania jako np. element testów regresji. W tym przypadku są zazwyczaj szybsze, tańsze w utrzymaniu oraz efektywniejsze.

Osobiście jednak uważam że nie mogą wustępować samodzielnie i proces testowania oparty tylko i wyłączeni na testowaniu API może sie sprawdzić tylko w przypadku specyficznych grup aplikacji o bardzo rozbudowanej warstwie backendowej a minimalnej warstwie interfejsu użytkownika.

4. Wiedza podstawowa niezbędna do testowania API 📗

Zanim przejdziemy do samego testowania trzeba poznać podstawy i zrozumieć podstawowe elementy komunikacji HTTP, która to nieodłącznie związana jest z Rest API. Do podstawowych informacji jakie musisz poznać należą: metody komunikacji, kody odpowiedzi oraz czym są request, respons oraz JSON.

Dwie gwiazdy testowania API i najważniejsze jego elementy to zdecydowanie:

• Request (żądanie): Jest to komunikat wysyłany przez klienta (np. przeglądarkę lub aplikację mobilną) do serwera w celu uzyskania dostępu do zasobu, jego utworzenia, aktualizacji lub usunięcia. Request to to co ty wysyłasz do aplikacji aby "coś z tym zrobiła". Reques posiada kilka charakterystycznych elementów takich jak adres, rodzaj metody, nagłówki oraz w zalezności od typu metody tzw. ciało metody (ang.body), dzieki któremu możemy przesyłać duże ilosci informacji.
• Response (odpowiedź): To odpowiedź serwera na żądanie klienta. Zawiera kod statusu HTTP, nagłówki oraz (opcjonalnie) dane w formacie JSON lub innym, w zależności od kontekstu. Gdy apliakcja odbierze przesłane przez ciebie informacje, przetworzy je zgodnie z oczwikiwaniem to wynik tej operacji wróci do ciebie w formie responsu.

Metody HTTP:

• GET: Metoda służąca do pobierania danych z określonego zasobu.
• POST: Służy do tworzenia nowego zasobu lub przesyłania danych do serwera.
• PUT: Używana do aktualizowania istniejących danych lub tworzenia nowego zasobu.
• DELETE: Metoda używana do usuwania zasobów z serwera.
• PATCH: Służy do częściowej aktualizacji istniejących zasobów.

Kody odpowiedzi HTTP:

• 1xx – Informacyjne: Tymczasowe odpowiedzi informujące, że serwer otrzymał żądanie i kontynuuje jego obsługę.
• 2xx – Sukces: Odpowiedzi wskazujące, że żądanie klienta zostało poprawnie przetworzone.
• 3xx – Przekierowanie: Wskazują, że klient musi wykonać dodatkowe działania, aby dokończyć żądanie.
• 4xx – Błędy po stronie klienta: Wskazują na błędy w żądaniu klienta.
• 5xx – Błędy po stronie serwera: Informują o błędach po stronie serwera.

JSON (JavaScript Object Notation):

Jest to popularny format wymiany danych, wykorzystywany głównie przez REST API. JSON charakteryzuje się prostotą i czytelnością zarówno dla ludzi, jak i maszyn. Dane w formacie JSON mają strukturę klucz-wartość, gdzie wartości mogą być typami prostymi (liczby, ciągi znaków, wartości logiczne) lub złożonymi (obiekty, tablice). Przykładowy obiekt JSON:

    {
      "id": 101,
      "name": "Jan Kowalski",
      "email": "jan.kowalski@example.com",
      "isActive": true,
      "roles": ["admin", "editor"],
      "address": {
        "street": "ul. Kwiatowa 15",
        "city": "Warszawa",
        "postalCode": "00-001",
        "country": "Polska"
      },
      "lastLogin": "2025-05-18T14:32:00Z"
    }
    

5. Narzędzia – od czego zacząć: Narzędzia deweloperskie przeglądarki 🌍

Pierwszym krokiem w testowaniu API jest wykorzystanie wbudowanych narzędzi deweloperskich przeglądarki, takich jak Chrome DevTools. To podstawowe narzędzie, które każdy tester powinien opanować, ponieważ daje dostęp do kluczowych informacji o komunikacji przeglądarki z serwerem.

W zakładce Network można sprawdzić: jakie żądania HTTP są wysyłane, jakie dane są przekazywane oraz jakie odpowiedzi otrzymujemy od serwera. Dzięki temu możemy łatwo zidentyfikować błędy w komunikacji z API, takie jak błędne nagłówki, niepoprawne dane w ciele żądania czy niewłaściwe odpowiedzi. Narzędzia deweloperskie pozwalają także na śledzenie czasów odpowiedzi i pomagają w optymalizacji procesu testowania bez konieczności korzystania z dodatkowych aplikacji czy usług. Dla testerów, którzy dopiero zaczynają swoją przygodę z API, to doskonały sposób na pierwsze zrozumienie jego działania.

Oto tylko przykład tego do czego możesz wykorzystać narzędzia developerskie przeglądarki jako tester:

• Monitorowanie żądań HTTP: Śledzenie wysyłanych i odbieranych żądań HTTP (np. za pomocą zakładki Network) w celu sprawdzenia komunikacji między przeglądarką a serwerem.
• Inspekcja odpowiedzi API: Sprawdzanie odpowiedzi serwera na wysyłane żądania, w tym kodów statusu, nagłówków i zawartości odpowiedzi (np. JSON) w zakładce Network.
• Symulowanie różnych warunków sieciowych: Testowanie aplikacji przy użyciu różnych prędkości połączenia internetowego (zakładka Network w narzędziach deweloperskich).
• Analiza wydajności strony: Mierzenie czasu ładowania strony oraz identyfikowanie problemów z wydajnością (zakładka Performance).

6. Narzędzia – krok dalej: Swagger 🧑‍🎓

Swagger (obecnie znany jako OpenAPI) to jedno z najbardziej popularnych narzędzi do dokumentowania i testowania API. Jest to narzędzie, które umożliwia testerom łatwe przeglądanie i testowanie dostępnych endpointów API w sposób wizualny, bez konieczności pisania skomplikowanego kodu.

Swagg nie do końca jest narzędziem dedykowanym testowaniu. Jednak nawet jesli docelowo korzystacie z bardziej zaawansowanych narzędzi to Swagger bedzie świetnym punktem startowym testowania.

Dzięki Swaggerowi możemy:

• Przeglądać dostępne endpointy API – narzędzie automatycznie generuje interaktywną dokumentację, która pokazuje, jak wykorzystywać poszczególne funkcje API.
• Testować API bezpośrednio z poziomu dokumentacji – za pomocą przycisków „Try it out” możemy wysyłać żądania do API, obserwując natychmiastowe odpowiedzi.
• Automatycznie generować dokumentację – Swagger pozwala na automatyczne tworzenie dokumentacji na podstawie definicji API, co pozwala zaoszczędzić czas i zwiększa spójność dokumentów.

Swagger jest niezastąpionym narzędziem zarówno dla testerów, jak i programistów, ułatwiającym szybkie i efektywne testowanie API w procesie developmentu.

7. Narzędzia – już prawie advance: POSTMAN 👨‍🏫

Postman to zaawansowane narzędzie przeznaczone do kompleksowego testowania API. Umożliwia tworzenie i zarządzanie złożonymi scenariuszami testowymi, a także automatyzację procesów testowych.

Z pomocą Postmana możemy:

• Tworzyć złożone scenariusze testowe: które obejmują różne przypadki użycia API, jak testowanie różnych metod HTTP (GET, POST, PUT, DELETE) czy testowanie różnych parametrów.
• Automatyzować testy: Postman oferuje możliwość uruchamiania testów automatycznych w formie kolekcji oraz skryptów, które pozwalają na regularne sprawdzanie działania API w sposób ciągły. Aby było to możliwe trzeba nasze testy uruchamiać za pomocą narzędzi do tego przeznaczonych np. Jenkins i Newman
• Zarządzać kolekcjami żądań: możemy przechowywać i zarządzać wieloma zestawami żądań w kolekcjach, co pozwala na łatwą organizację testów i szybkie przeglądanie historii testów.
• Testować zabezpieczenia: np. przez weryfikację mechanizmów uwierzytelniania (API keys, OAuth, JWT).

Postman to idealne narzędzie dla testerów, którzy chcą w pełni wykorzystać potencjał testowania API i przejść na wyższy poziom profesjonalizmu w swojej pracy.

Należy również pamiętać żę Postman reprezentuje tu pewną klasę narzędzi jako ich najpopularniejszy przedstawiciel. Jednak na rynku wystepuje obecnie dość spora konkurencja dla tego typu rowziązań do których zaliczyć możemy:

• Bruno: https://www.usebruno.com
• SoapUI: https://smartbear.com
• HoppScotch: https://hoppscotch.io

8. Naprawdę Advance – Biblioteki: REST ASSURED 🏋️‍♂️

REST Assured to zaawansowana biblioteka w języku Java, dedykowana do testowania API, która umożliwia tworzenie testów automatycznych w sposób płynny i efektywny. Jest to narzędzie dedykowane dla testerów, którzy chcą przejść na najwyższy poziom automatyzacji testów API.

Z pomocą REST Assured możemy:

• Pisać testy automatyczne: biblioteka umożliwia łatwe definiowanie testów API za pomocą prostych i czytelnych skryptów w języku Java, co jest szczególnie przydatne przy tworzeniu zautomatyzowanych testów regresyjnych.
• Integrację z frameworkami: takimi jak JUnit czy TestNG – REST Assured współpracuje z popularnymi frameworkami testowymi, co umożliwia tworzenie bardziej zaawansowanych zestawów testów i organizowanie ich w struktury projektów.
• Szczegółową walidację odpowiedzi: REST Assured oferuje bogaty zestaw metod do walidacji odpowiedzi API, umożliwiając sprawdzenie statusu odpowiedzi, zawartości ciała odpowiedzi, nagłówków czy czasu odpowiedzi.

Jest to narzędzie, które pozwala testerom przenieść testowanie API na wyższy poziom automatyzacji i dokładności, stanowiąc fundament w bardziej zaawansowanych projektach testowych.

Wykorzytanie biblioteki oraz jeżyka programowania może okazać sie niezwykle praktycznie gdy nasz zestaw testów API jest potężny, skomplikowany i wymaga skomlikowanych operacji związanych np z przekazywaniem parametrów.

Takie podejście pozwala również na wykorzystanie biblioteki do testów API z innymi narzędziami takimi jak Selenium, bazy danych oraz wiele wiele innych. Daje to zupełnie nowe ogromne z punktu widzenia testerów możliwości.

9. Plan nauki testowania REST API 📋

Oto sugerowany plan nauki dla początkujących:

• Poznaj podstawy komunikacji sieciowej oraz metody i kody odpowiedzi HTTP
• Zacznij od narzędzi deweloperskich przeglądarki
• Zapoznaj się ze Swagger/OpenAPI
• Naucz się podstaw Postmana i budowania kolekcji testów
• Przejdź do automatyzacji testów z REST Assured
• Rozwijaj swoje umiejętności pisania testów automatycznych i raportowania

10. Zakończenie ✈️

Testowanie REST API jest niezwykle ważnym elementem w procesie rozwoju oprogramowania. Zaczynając od prostych narzędzi, stopniowo rozwijając wiedzę i umiejętności, można szybko stać się wartościowym specjalistą od testów usług webowych.

📙 Pamiętajcie więcej o testowani API i komunikacji sieciowej dowiecie sie z naszego kursu: Kursy WSQI

📽️ Zapraszamy również na nasz kanał YT: WSQI YT