Testowanie interfejsu API REST za pomocą listonosza

Testowanie interfejsu API REST za pomocą listonosza
Postman to oprogramowanie, którego można użyć do testowania interfejsów API REST. Postman ma łatwy w użyciu graficzny interfejs użytkownika. Ma również wiele przydatnych funkcji, które pomogą w testowaniu interfejsu API REST. Postman jest dostępny dla systemu Windows, Mac i Linux. Postman jest również dostępny jako wtyczka Chrome. Możesz więc użyć Postman w przeglądarce Google Chrome. Postman ma bezpłatną wersję i płatne wersje. Możesz zrobić prawie wszystko z bezpłatną wersją. W tym artykule użyję bezpłatnej wersji.

W tym artykule pokażę, jak przetestować API REST za pomocą listonosza. Zacznijmy.

Instalowanie listonosza jako rozszerzenia Chrome:

W tej sekcji pokażę Ci, jak zainstalować liston.

Najpierw przejdź do strony rozszerzenia listonowego w Chrome Web Store pod adresem https: // chrome.Google.com/weebstore/detail/liter?hl = en

Teraz kliknij Dodaj do Chrome.

Teraz kliknij Dodaj aplikację.

Postan powinien zostać zainstalowany. Teraz możesz kliknąć Uruchom aplikację rozpocząć listonę.

Lub możesz kliknąć Aplikacje.

I zacznij postmon stamtąd.

Jeśli po raz pierwszy otworzysz listonosze, powinieneś zobaczyć następujące okno. Kliknij link, jak zaznaczono na zrzucie ekranu poniżej, jeśli nie masz konta lub nie chcesz się zalogować.

Postman powinien się zacząć.

Główne okno listonosza:

Możesz także zainstalować postmanem natywnie na Linux. Nie ma zakresu tego artykułu. Więc nie mogę tego tutaj pokazać.

Konfigurowanie serwera API testu:

Napisałem interfejs API za pomocą węzła.JS, których będę używać w tym artykule, aby pokazać, jak używać listonosza do testowania interfejsów API. Jeśli chcesz śledzić, możesz po prostu sklonować moje repozytorium Github Angular-hero-api i uruchom ten sam serwer API, co ja.

Klon moje repozytorium Github za pomocą następującego polecenia:

$ git clone https: // github.com/shovon8/angular-hero-api

Teraz przejdź do Angular-hero-api/ informator:

$ CD Angular-hero-api/

Teraz zainstaluj wszystkie wymagane moduły węzłów:

$ npm instalacja

Na koniec uruchom serwer API z następującym poleceniem:

Test $ NPM

Jak widać, serwer API działa na porcie 4242.

Podstawy listonosza:

Po pierwsze, otwórz listonę i powinno wyglądać mniej więcej tak.

Możesz wpisać adres URL punktu końcowego API w zaznaczonej sekcji zrzutu ekranu poniżej.

Możesz wybrać metodę żądania (taką jak Get, Post, Putt itp.) Z menu rozwijanego, jak zaznaczono na zrzucie ekranu poniżej.

Kiedy już skończysz, kliknij Wysłać Aby wysłać żądanie API. Wynik powinien być wyświetlany.

Zobaczysz, jak wszystko działa w następnej sekcji tego artykułu.

Używanie listonosza do testowania interfejsów API REST:

Jeśli chcesz wykonać żądanie GET w interfejsie API, wpisz adres URL punktu końcowego API, ustaw metodę na DOSTAWAĆ, i na koniec kliknij Wysłać.

Na przykład, aby uzyskać listę wszystkich bohaterów w bazie danych, wykonaj DOSTAWAĆ żądanie serwera API /API/Heroes punkt końcowy. Po naciśnięciu Wysłać, wyjście powinno być wyświetlane w formacie JSON, jak widać na zrzucie ekranu poniżej.

Możesz także wykonać żądanie postu na swoim serwerze API za pomocą listonosza. Skonfigurowałem mój serwer API w taki sposób, że tworzy nowy bohater na żądanie postu. Aby stworzyć nowego bohatera, ustaw metodę POST i punkt końcowy API do /api /bohaterów; Następnie kliknij Ciało jak zaznaczono na zrzucie ekranu poniżej.

Teraz kliknij surowy i wybierz JSON (aplikacja/JSON) z menu rozwijanego typu, jak zaznaczono na zrzucie ekranu poniżej.

Na koniec wpisz informacje bohatera, którego chcesz wstawić do formatu JSON i kliknij Wysłać.

Jak widać, bohater jest wstawiany z ID 21.

Wszystkie prośby API, które składasz, jest zapisane w historii Listerstwa. Aby użyć żądania interfejsu API z historii, po prostu kliknij, a następnie kliknij Wysłać.

Jak widać, prośba API o listę wszystkich bohaterów, których zrobiliśmy wcześniej, jest wymieniony w historii. Po kliknięciu powinien otworzyć się w nowej karcie. Na koniec kliknij Wysłać.

Jak widać, wszyscy bohaterowie są wymienione, w tym nasz nowy bohater.

Możesz także usunąć bohatera z listy za pomocą USUWAĆ Metoda na/API/HERO/ punkt końcowy. Tutaj, to identyfikator bohatera, którego chcesz usunąć.

Powiedzmy, że chcesz usunąć bohatera z ID 20. Więc punkt końcowy API jest /API/Hero/20 A metoda jest USUWAĆ. Jak widać, powodzenie Wiadomość jest zwracana. Bohater powinien zostać usunięty.

Jak widać, bohater z ID 20 jest usuwany.

Wcześniej pokazałem ci, jak wysyłać informacje w formacie JSON na serwer API. Tutaj pokażę ci, w jaki sposób wysyłaj informacje w formacie zakodowanym adresem URL. Po przesłaniu formularza HTML do serwera jest to format używany domyślnie.

Powiedzmy, że chcesz zaktualizować bohatera w API serwer. Aby to zrobić, musisz użyć SKRAWEK Metoda ON/API/HERO/ punkt końcowy, ponieważ to właśnie skonfigurowałem na moim serwerze API. Tutaj to identyfikator bohatera, którego chcesz zaktualizować.

Na przykład zmieńmy nazwę bohatera z identyfikatorem 19 z Magma Do Ordynans. Tak więc punkt końcowy API powinien być /API/Hero/19 i metoda powinna być SKRAWEK. Teraz kliknij Ciało a także wybierz X-WWW-Form-Uurlencoded jak zaznaczono na zrzucie ekranu poniżej.

Teraz ustaw klucz na nazwa i wartość do Ordynans jak zaznaczono na zrzucie ekranu poniżej. Na koniec kliknij Wysłać.

Jak widać, wyświetlane są zaktualizowane dane. Co oznacza, że ​​operacja aktualizacji się powiodła.

Jeśli ponownie wymieniisz wszystkich bohaterów, powinieneś zobaczyć zaktualizowane dane, jak widać na zrzucie ekranu poniżej.

Takie są podstawy listonosza. Postman ma mnóstwo funkcji i opcji, których możesz użyć, aby ułatwić swoje życie jako programista API. Dziękuję za przeczytanie tego artykułu. Baw się dobrze ze swoim listonoszem!