Jak przetestować interfejs API za pomocą listonosza

Listonosz jest klientem API wykorzystywanym do opracowywania, udostępniania, testowania i dokumentowania interfejsów API. Pozwala nam również przeprowadzić testy zaplecza poprzez wprowadzanie adresu URL punktu końcowego. Wniosek zostanie następnie wysłany do węzła.serwer JS i odpowiada na aplikację listonosza. Inżynierowie i programiści automatyzacji szeroko używają go, aby sprawdzić, czy ich serwer jest uruchomiony.

Ten zapis pokaże, jak to zrobić test jakiś API za pomocą listonosza. Ponadto, zostanie również podana procedura korzystania z Post, Get i usuwania żądań HTTP do tworzenia, aktualizacji, pobierania i usuwania informacji z bazy danych MongoDB. A więc zacznijmy!

Jak przetestować interfejs API za pomocą listonosza

Utworzyliśmy już prostą aplikację systemu zarządzania pracownikami z React.JS Front End, węzeł.serwer JS i nawiązał połączenie między serwerem a bazą danych MongoDB. Po tym dodaliśmy dwa modele: „pracownik.Model" I "Przeznaczenie.Model„Z ich powiązanym schematem. Modele te są następnie wykorzystywane do definiowania „trasy„Zawierające punkty końcowe dla żądań HTTP.

Teraz przetestujemy interfejs API za pomocą listonosza i sprawdzimy, czy nasze dodane punkty końcowe działają. Chcę to zrobić? Jeśli tak, to najpierw zainstaluj go w swoim systemie za pomocą oficjalnej strony internetowej:

Po zainstalowaniu Postmana przejdź do procedury testowania działających żądań.

Jak przetestować żądanie pocztowe za pomocą listonosza

Postman obsługuje różne metody interakcji punktu końcowego i „POST”Jest jednym z nich. Jest wykorzystywany do tworzenia i aktualizacji zasobu lub wysyłania danych do serwera. Ponadto żądania pocztowe nie mają żadnych ograniczeń związanych z długością danych.

Aby przetestować żądanie pocztowe za pomocą Postmana, po pierwsze, wybierz „POST”Z rozwijanego menu żądania HTTP:

W następnym kroku dodamy poniżej podany link w polu URL żądania. Określony link będzie dostępny do „pracownicy„Plik trasy, który obsługuje„POST" wniosek:

http: // localhost: 5000/pracownicy/dodaj

Teraz przejdź do „Ciało”Tab, wybierz„surowy”I dodaj ciało swoich żądań pocztowych. Tutaj dodajemy nowego pracownika: „Stepheny„Do naszej bazy danych:

„Auctioneename”: „Stepheny”

W następnym kroku wybierz „JSON”Jako parametr ciała żądania:

Następnie kliknij „Wysłać”Przycisk, aby wysłać dodane żądanie Post do węzła.serwer JS:

Po wykonaniu określonej operacji zobaczysz „Dodano pracownik„Tekst jako odpowiedź na żądanie post:

Dodano poprzednią żądanie postu „Stepheny ” do "pracownik" Baza danych. Postępując zgodnie z tą samą metodą, dodamy innego pracownika o nazwie „Albert”:

„Auctioneename”: „Albert”

Poniższe dane wyjściowe wskazuje, że pomyślnie dodaliśmy „Albert„Jako nowy pracownik:

Możesz także skorzystać z „POST”Prośba o aktualizację informacji związanych z dowolnym konkretnym identyfikatorem. Na przykład, aby zaktualizować wartości pól identyfikatora oznaczenia „61CCBF563C71F2DDC072569B”, Wyślemy żądanie pocztowe posiadające następujący adres URL:

http: // localhost: 5000/określenie/aktualizacja/61ccbf563c71f2ddc072569b

W biegu żądania postu dodamy zaktualizowane wartości zgodnie z „Przeznaczenie" Model:

„Auctioneename”: „Albert”,
„Oznaczenie”: „CEO”,
„Data”: „2021-12-29t19: 48: 13.015Z "

Klikając „Wysłać„Button, zobaczysz„Oznaczenie zaktualizowane!„Tekst w sekcji odpowiedzi:

Jak przetestować żądanie GET za pomocą listonosza

W Postman żądanie GET pobiera dane z określonego adresu URL. Ten typ żądania HTTP nie wprowadzi żadnych zmian w punkcie końcowym.

Aby przetestować żądanie GET za pomocą Postmana, wybierz „DOSTAWAĆ„Jako metoda interakcji punktu końcowego:

Następnie wklejemy następujący adres URL w polu łącza wejściowego:

http: // localhost: 5000/pracownicy/

Następnie kliknij Wysłać przycisk, aby złożyć żądanie HTTP. To żądanie GET uzyska wszystkie dane związane z „pracownik„Zbieranie naszej bazy danych MongoDB i pokaż dodane dane pracowników w odniesieniu do zdefiniowanego schematu:

Możesz także użyć „DOSTAWAĆ”Prośba o uzyskanie informacji związanych z konkretnym rekordem na podstawie jego identyfikatora.

Na przykład dodanie linku poniżej, a następnie wysyłanie „DOSTAWAĆ„Żądanie przyniesie dane identyfikatora oznaczenia”61CCBF563C71F2DDC072569B”:

http: // localhost: 5000/określenie/61ccbf563c71f2ddc072569b

Jak widać, ta odpowiedź „DOSTAWAĆ”Żądanie pokazuje swoje wartości pola w określonym schemacie:

Jak przetestować żądanie usuwania za pomocą listonosza

Żądanie usuwania HTTP w Postman jest używane do usuwania informacji z kolekcji bazy danych. Na przykład w tej chwili mamy dwa rekordy pracowników w „oznaczenia„Kolekcja bazy danych i aby usunąć dowolny z nich, wykorzystamy ich identyfikator.

Teraz, aby usunąć „Albert„Informacje, użyjemy jego identyfikatora, czyli„ ”61CCBF563C71F2DDC072569B,”A potem zrób„USUWAĆ" wniosek:

http: // localhost: 5000/określenie/61ccbf563c71f2ddc072569b

Kliknij na "Wysłać”Przycisk, a zauważysz, że w ciągu kilku sekund informacje usunięto do dodanego„ID„Zostanie usunięty i„Oznaczenie usunięte.„Tekst zostanie wyświetlony w odpowiedzi na złożoną prośbę:

W celu weryfikacji możesz wysłać „DOSTAWAĆ”Prośba o pokazanie informacji przechowywanych w„oznaczenia„Kolekcja MongoDB:

http: // localhost: 5000/oznaczenia/

Z poniższego obrazu widać, że tylko informacje związane z „Stepheny”Jest wyświetlany jako odpowiedź, która deklaruje, że poprzedni„USUWAĆ„Wniosek zadziałał:

Wniosek

Postman to oprogramowanie, które jest wykorzystywane do testowania interfejsów API. Jest to rodzaj klienta HTTP, który korzysta z graficznego interfejsu użytkownika, za pośrednictwem którego można wysyłać różne typy żądań i uzyskać ich odpowiedzi, które sprawdzają wynik żądania. Ten zapis wykazał, jak testować interfejs API za pomocą listonosza. Ponadto, podano również procedurę korzystania z postu, Get i usuwania żądań HTTP do tworzenia, aktualizacji, pobierania i usuwania informacji z bazy danych MongoDB.