Testowanie API za pomocą Postmana

Na początek zobaczmy, co mówią sami twórcy Postmana:

„Postman to mocny zestaw narzędzi do testowania API, bez których wielu programistów już się nie obejdzie. Robimy świetne produkty, które pomagają tworzyć znakomite API i pracować wydajniej. Z Postmana korzysta ponad milion programistów na świecie, a liczba ta stale rośnie. Planujemy rozwijać także inne produkty, by dać programistom najmocniejsze rozwiązanie do tworzenia i testowania API”.

Obecna wersja Postmana jest jeszcze mocniejsza od dawnych, a sporo możliwości Pro jest teraz dostępnych za darmo. Co więcej, narzędzie to powstało nie tylko dla programistów. Nawet sprawdzanie automatycznych odpowiedzi nie wymaga szczególnej wiedzy. To bardzo proste, a zarazem mocne narzędzie.

Wysłać żądanie

Jeśli otworzycie ten zestaw, przejdziecie do „Request Methods”, a potem do „GET Requests”, wszystkie zapisane dane pojawią się w środkowej części okna Postmana. Teraz kliknijcie „Submit”. Właśnie wysłaliście swoje pierwsze żądanie i otrzymaliście pierwszą odpowiedź.

Żądania POST są nieco trudniejsze, ale równie zrozumiałe i logiczne. Tym razem użyjecie własnego żądania. Kliknijcie plus, by otworzyć nową kartę, zmieńcie typ żądania z GET na POST i podajcie https://jsonplaceholder.typicode.com/posts jako adres żądania. To bezpłatna usługa REST, której można używać do zmyślonych danych. Bardzo przydaje się do nauki, udawania pracy serwera i rozpowszechniania przykładów kodu.

Teraz potrzebne jest ciało żądania POST. Kliknijcie „Body” pod adresem żądania, zmieńcie typ na „raw”, a „Text” na „JSON”. Teraz wklejcie do edytora takie zapytanie: 

1. {
2. „title”: „My first POST request”,
3. „body”: „Content of my first POST request!”,
4. „userId”: 789
5. }

Kliknijcie „send”. Powinniście dostać odpowiedź ze swoim tekstem — potwierdzenie, że żądanie się powiodło. Zapiszcie je na przyszłość. Można też stworzyć nową kolekcję: wystarczy kliknąć „Save” na prawo od adresu żądania. Otworzy się okno zapisu, w którym żądaniu można nadać nazwę i stworzyć dla niego nową kolekcję.

Sprawdzenia

Kolejną świetną możliwością Postmana są automatyczne sprawdzenia żądań. Gdy raz stworzycie sprawdzenie dla żądania, Postman będzie badał każdą przychodzącą odpowiedź według waszych scenariuszy. Spójrzmy na prosty przykład.

Dodajcie nowe własne żądanie pobrania POST z https://jsonplaceholder.typicode.com/posts o ID = 6 i otwórzcie kartę „Tests”. Po prawej stronie okna Postmana zobaczycie listę gotowców. Pomogą ułożyć i pierwsze sprawdzenie, i drugie, i wszystkie następne, bo ten kod nadaje się do wszystkiego — trzeba go tylko nieco dopasować do swoich potrzeb.

tests[„Status code is 200”] = responseCode.code === 200;

1. var jsonData = JSON.parse(responseBody);
2. tests[„User ID is 1”] = jsonData.userId === 1;
3. tests[„Post ID is 6”] = jsonData.id === 6;
4. tests[„Body matches string”] = responseBody.has(„dolorem eum magni eos aperiam quia”);
5. W pierwszym sprawdzeniu zobaczymy, czy odpowiedź na nasze żądanie zwraca stan HTTP „200”, czy identyfikator użytkownika wynosi 1, identyfikator wpisu 6 i czy w ciele odpowiedzi znajduje się potrzebny tekst.

Teraz po prostu kliknijcie „Submit”. Kiedy odpowiedź nadejdzie, otwórzcie kartę „Tests” i sprawdźcie, czy wszystko przeszło.

Tym artykułem chcieliśmy pokazać, jak prosto i przyjemnie pracuje się z Postmanem!