Samouczek testowania API REST – przykładowe ręczne przypadki testowe
Tomasza Hamiltona
Co to jest testowanie API REST?
Testowanie API REST to technika testowania automatyzacji sieci WWW o otwartym kodzie źródłowym, używana do testowania interfejsów API RESTful dla aplikacji internetowych. Celem testowania rest api jest rejestrowanie odpowiedzi rest api poprzez wysyłanie różnych żądań HTTP/S w celu sprawdzenia, czy rest api działa poprawnie, czy nie. Resztę testów API wykonuje się metodami GET, POST, PUT i DELETE.
Reszta oznacza Representational State Transfer. Jest to styl architektoniczny i podejście do komunikacji stosowane w rozwoju Web Services. REST stał się logicznym wyborem przy tworzeniu interfejsów API. Umożliwia użytkownikom efektywne łączenie się z usługami w chmurze i interakcję z nimi.
API, czyli interfejs programowania aplikacji (API), to zestaw instrukcji programistycznych umożliwiających dostęp do aplikacji internetowej. Innymi słowy, zestaw poleceń używanych przez poszczególne programy do bezpośredniej komunikacji i korzystania z funkcji innych programów w celu uzyskania informacji. Na przykład: Google Strona internetowa może mieć API dla różnych funkcji, takich jak wyszukiwanie, tłumaczenia, kalendarze itp.
Ogólnie interfejsy API są takie jak poniżej, mają nazwę serwera, ścieżki itp
http://<server name>/v1/export/Publisher/Standard_Publisher_Report?format=csv
Rodzaje metod API
Istnieją głównie 4 rodzaje Testowanie API metody: GET, POST, Delete i PUT.
- GET– Metoda GET jest używana dotracInformacje z danego serwera za pomocą podanego URI. Podczas korzystania z żądania GET należy jedynietracdanych i nie powinno mieć na nie żadnego innego wpływu.
- POST– Do utworzenia nowej jednostki używane jest żądanie POST. Można go również wykorzystać do przesyłania danych na serwer, np. informacji o klientach, przesyłania plików itp. za pomocą formularzy HTML.
- PUT– Utwórz nowy podmiot lub zaktualizuj istniejący.
- DELETE– Usuwa wszystkie bieżące reprezentacje zasobu docelowego podane przez identyfikator URI.
Jak przetestować API REST
Testowanie interfejsu API wymaga interakcji aplikacji z przykładowym interfejsem API w celu testowania. Aby przetestować API, potrzebujesz dwóch rzeczy:
- Narzędzie/rama testowa do obsługi interfejsu API
- Napisanie własnego kodu w celu przetestowania przykładowego API REST
Przypadki testowe Rest API można testować za pomocą narzędzi takich jak:
- Zaawansowany klient odpoczynku
- Postman-Odpocznij Kliencie
- Curl w Linuksie
Tutaj będziemy używać Advanced Rest Client, poniżej znajdują się kroki, aby uzyskać Advance Rest Client,
Jak zdobyć zaawansowanego klienta odpoczynku?
- Iść do Google ChromeSklep internetowy
- Wyszukaj „Advanced Rest Client” lub przejdź bezpośrednio w tym miejscu i Zainstaluj rozszerzenie
- Wybierz ikonę „Zaawansowany klient odpoczynku” w sekcji aplikacji Chrome – chrome://apps/
Po zakończeniu instalacji wykonaj poniższy test w celu przetestowania RESTful API
Kroki testowania interfejsu API REST
Tutaj używamy rozszerzenia klienta odpoczynku w przeglądarce Chrome. Aby wszystko było jasne, do testów używamy fikcyjnego API”
http://ip.jsontest.com/
Krok 1) Otwórz zaawansowanego klienta REST
Uruchom aplikację Zaawansowany klient REST (ARC) po pomyślnym zainstalowaniu.
Krok 2) Wprowadź URL API do testowania
Wprowadź przykładowy interfejs API REST URL do testowania w URL pole tekstowe.
Krok 3) Wybierz metodę HTTP
Wybierz metodę typu metod HTTP w testowaniu API, które mają zostać trafione – np. POST
Krok 4) Podaj zestaw nagłówków
Podaj zestaw nagłówków w polu tekstowym Nagłówki. Kliknij na Wstaw zestaw nagłówków.
Krok 5) Potwierdź ustawienie nagłówków
Następnie kliknij UŻYJ TEGO ZESTAWU.
Krok 6) Podaj wymaganą treść treści
- Teraz przejdź do zakładki Treść.
- Ustaw wymagany typ zawartości treści i widok edytora, np. typ zawartości treści: aplikacja/json
- Widok edytora: surowe dane wejściowe.
- W obszarze Payload przekaż treść żądania demonstracyjnego API do testowania w postaci par klucz-wartość, np. {{„key1″:”value1″,”key2″:”value2”}. Jeśli jest to post API, musimy przekazać treść lub parametry. Przejdziemy pod zadanym ładunkiem.
{"property" : ["Sites"], "report_type" : ["ALL"]}
Krok 7) Prześlij szczegóły, aby rozpocząć test
- Naciśnij przycisk wysyłania.
- Aby zobaczyć nagłówki odpowiedzi, kliknij przycisk SZCZEGÓŁY.
Oto szczegóły odpowiedzi:
Walidacja wyników
Głównie w przypadku testowania interfejsu API sieci Web musimy sprawdzić kod odpowiedzi, komunikat odpowiedzi i treść odpowiedzi.
Poniżej znajdują się różne kody odpowiedzi, które można napotkać podczas testowania API.
Narzędzie do testowania interfejsu API REST
Wyzwania związane z testowaniem API
Do interesujących problemów testerów podczas testowania usług REST należą:
- Aby upewnić się, że wiązka testowa zmienia parametry wywołań API w taki sposób, aby zweryfikować funkcjonalność i ujawnić awarie. Obejmuje badanie warunków brzegowych i przypisywanie wspólnych parametrów
- Tworzenie interesujących kombinacji wartości parametrów dla wywołań z dwoma lub większą liczbą parametrów
- Identyfikacja treści, w ramach której należy wykonać wywołania API. Może to obejmować ustawienie warunków środowiska zewnętrznego (urządzenia peryferyjne, pliki itp.), a także danych przechowywanych wewnętrznie, które mają wpływ na interfejs API
- Sekwencjonowanie wywołań API zgodnie z kolejnością wykonywania funkcji
- Aby interfejs API generował przydatne wyniki z kolejnych wywołań.
Podsumowanie
- Interfejs API lub interfejs programowania aplikacji to zestaw instrukcji programistycznych umożliwiających dostęp do aplikacji internetowej.
- Istnieją głównie 4 metody testowania automatyzacji API REST, takie jak GET, POST, Delete i PUT.
- Musimy sprawdzić kod odpowiedzi, komunikat odpowiedzi i treść odpowiedzi w przypadkach testowych API Testing.
