Menu

Kody odpowiedzi Rest API i rodzaje żądań odpoczynku

  • Główny
  • Inny
  • Kody odpowiedzi Rest API i rodzaje żądań odpoczynku

rest api response codes

Wypróbuj Nasz Instrument Do Eliminowania Problemów

W tym samouczku dowiemy się o różnych kodach odpowiedzi REST, typach żądań REST i niektórych najlepszych praktykach, których należy przestrzegać :

W poprzednim samouczku, Architektura REST API i ograniczenia, dowiedzieliśmy się o usługach internetowych, architekturze REST, POSTMAN itp.

Więcej informacji na ten temat można znaleźć w pierwszym samouczku dotyczącym interfejsu API REST.

Za każdym razem, gdy wyszukujesz dowolne słowo lub frazę w wyszukiwarce, wyszukiwarka wysyła żądanie do serwera internetowego. Serwer sieciowy zwraca trzycyfrowy kod odpowiedzi, który wskazuje stan żądania.

Różne typy kodów odpowiedzi i żądania odpoczynku

Czego się nauczysz:

Kody odpowiedzi REST API

Oto kilka przykładowych kodów odpowiedzi, które normalnie zobaczymy podczas testowania REST API przez POSTMAN lub na dowolnym kliencie REST API.

# 1) Seria 100
To są odpowiedzi tymczasowe

  • 100 Kontynuuj
  • 101 Przełączanie protokołów
  • 102 Processing

# 2) Seria 200
Klient akceptuje żądanie, które jest pomyślnie przetwarzane na serwerze.

otwieranie pliku xml w programie Excel
  • 200 - OK
  • 201 - Utworzono
  • 202 - Zaakceptowano
  • 203 - Informacje nieautorytatywne
  • 204 - Brak treści
  • 205 - Resetuj zawartość
  • 206 - Częściowa zawartość
  • 207 - Wiele statusów
  • 208 - Już zgłoszono
  • 226 - IM używany

# 3) Seria 300
Większość kodów związanych z tą serią dotyczy przekierowań adresów URL.

  • 300 - Wiele możliwości wyboru
  • 301 wyprowadził się permamentnie
  • 302 - Znaleziono
  • 303 - Sprawdź inne
  • 304 - Nie zmodyfikowano
  • 305 - Użyj proxy
  • 306 - Przełącz serwer proxy
  • 307 - Tymczasowe przekierowanie
  • 308 - Trwałe przekierowanie

# 4) Seria 400
Są one specyficzne dla błędu po stronie klienta.

  • 400 - Złe żądanie
  • 401 - nieautoryzowany
  • 402 - Wymagana płatność
  • 403 - Zabronione
  • 404 Nie Znaleziono
  • 405 - Metoda niedozwolona
  • 406 - Niedopuszczalne
  • 407 - Wymagane uwierzytelnienie proxy
  • 408 - Limit czasu żądania
  • 409 - Konflikt
  • 410 - Zniknął
  • 411 - Wymagana długość
  • 412 - Niesprawny warunek wstępny
  • 413 - Za duży ładunek
  • 414 - Zbyt długi identyfikator URI
  • 415 - Nieobsługiwany typ nośnika
  • 416 - Zakres niezadowalający
  • 417 - Spełnienie oczekiwań
  • 418 - Jestem imbirem
  • 421 - Błędnie skierowane żądanie
  • 422 - Podmiot niemożliwy do przetworzenia
  • 423 - Zamknięte
  • 424 - Niepowodzenie zależności
  • 426 - Wymagana aktualizacja
  • 428 - Wymagany warunek wstępny
  • 429 - Zbyt wiele żądań
  • 431 - Zbyt duże pola nagłówka żądania
  • 451 - Niedostępne z powodów prawnych

# 5) Seria 500
Są one specyficzne dla błędu po stronie serwera.

  • 500 wewnętrzny błąd serwera
  • 501 - Nie wdrożono
  • 502 - Zła brama
  • 503 Usługa niedostępna
  • 504 - Limit czasu bramy
  • 505 - Nieobsługiwana wersja HTTP
  • 506 - Wariant również negocjuje
  • 507 - Za mało miejsca
  • 508 - Wykryto pętlę
  • 510 - nie przedłużony
  • 511 - Wymagane uwierzytelnienie sieciowe

Poza tym istnieje kilka różnych kodów, które jednak odbiegają od naszej obecnej dyskusji.

Różne typy żądań REST

Tutaj omówimy każdą metodę REST API wraz z kolekcjami.

metodaOpis
ŁATABardzo podobny do wyrażenia, ale bardziej przypomina drobną manipulację zawartością zasobów
OTRZYMAĆPobierz wiersz statusu, treść odpowiedzi, nagłówek itp.
GŁOWATo samo co GET, ale pobiera tylko wiersz stanu i sekcję nagłówka
POCZTAWykonuj żądania przy użyciu ładunku żądania, głównie podczas tworzenia rekordu na serwerze
POŁOŻYĆPrzydatne w manipulowaniu / aktualizowaniu zasobu przy użyciu ładunku żądania
KASOWAĆUsuwa informacje dotyczące zasobu docelowego.
OPCJEOpisz opcje komunikacji dla zasobu docelowego

Uwaga: Istnieje tak wiele metod, które możemy wykonać za pomocą POSTMAN, ale będziemy omawiać tylko następujące metody przy użyciu POSTMAN.

Do zademonstrowania użyjemy fikcyjnego adresu URL http://jsonplaceholder.typicode.com . Ten adres URL da nam pożądane odpowiedzi, ale na serwerze nie będzie żadnego tworzenia, modyfikacji.

# 1) POBIERZ

Parametry żądania:
Metoda: GET
Identyfikator URI żądania: http://jsonplaceholder.typicode.com/posts
Parametr zapytania: id = 3;

Otrzymana odpowiedź:
Kod stanu odpowiedzi: 200 OK

Treść odpowiedzi :

Treść odpowiedzi

# 2) GŁOWA

Parametry żądania:
Metoda: GŁOWA
Identyfikator URI żądania: http://jsonplaceholder.typicode.com/posts

GŁOWA

# 3) POST

POCZTA

# 4) PUT

POŁOŻYĆ

KASOWAĆ

# 5) OPCJE

Parametry żądania:
Metoda: OPCJE
Identyfikator URI żądania: http://jsonplaceholder.typicode.com/
Nagłówki: Content-type = Application / JSON

najlepsze oprogramowanie do tworzenia kopii zapasowych dla systemu Windows 10 za darmo

OPCJE

# 6) PATCH

ŁATA

Najlepsze praktyki podczas sprawdzania poprawności REST API

# 1) Operacje CRUD

Składają się z co najmniej 4 dostarczonych metod i powinny działać w interfejsie API sieci Web.
GET, POST, PUT i DELETE.

# 2) Obsługa błędów

Możliwe wskazówki dla użytkowników API na temat błędu i przyczyny jego wystąpienia. Powinien również zawierać szczegółowe komunikaty o błędach.

# 3) Wersjonowanie API

Użyj litery „v” w adresie URL, aby wskazać wersję interfejsu API. Na przykład-

http://restapi.com/api/v3/passed/319

Dodatkowy parametr na końcu adresu URL

http://restapi.com/api/user/invaiiduser?v=6.0

# 4) Filtrowanie

Umożliwiając użytkownikowi określenie, wybierz żądane dane zamiast podawać je wszystkie naraz.
/ kontakt / sam? imię i nazwisko, wiek, stanowisko, biuro
/ kontakty? limit = 25 i przesunięcie = 20

# 5) Bezpieczeństwo

Znacznik czasu w każdym żądaniu i odpowiedzi API. Użycie access_token, aby upewnić się, że API jest wywoływane przez strony zaufania.

pytania do wywiadu do działu pomocy technicznej

6) Analityka

Posiadanie Analytics w REST API daje dobry wgląd w testowany API, zwłaszcza gdy liczba pobranych rekordów jest bardzo wysoka.

# 7) Dokumentacja

Należy zapewnić odpowiednią dokumentację, aby konsumenci API mogli z niej korzystać i efektywnie korzystać z usług.

# 8) Struktura adresu URL

Struktura adresu URL powinna pozostać prosta, a użytkownik powinien mieć możliwość łatwego odczytania nazwy domeny.

Na przykład , https://api.testdomain.com.

Operacje wykonywane przez Rest API powinny być również bardzo łatwe do zrozumienia i wykonania.

Na przykład dla klienta poczty e-mail:

OTRZYMAĆ: przeczytaj / odebrane / wiadomości - pobiera listę wszystkich wiadomości w skrzynce odbiorczej
OTRZYMAĆ: odczyt / odebrane / wiadomości / 10 - czyta 10thwiadomość w skrzynce odbiorczej
POCZTA: create / inbox / folders - Utwórz nowy folder w skrzynce odbiorczej
KASOWAĆ: Usuń / spam / wiadomości - Usuń wszystkie wiadomości z folderu spamu
POŁOŻYĆ: foldery / skrzynka odbiorcza / podfolder - zaktualizuj informacje dotyczące podfolderu w skrzynce odbiorczej.

Wniosek

Wiele organizacji woli wdrożyć REST Web API, ponieważ jest bardzo łatwy do wdrożenia, ma mniej standardów i reguł do przestrzegania, jest łatwy do uzyskania, lekki i łatwy do zrozumienia. POSTMAN ma swoje zalety, gdy jest używany z RESTful API ze względu na przyjazny dla użytkownika interfejs użytkownika, łatwość użycia i testowania, szybszą reakcję i nową funkcję RUNNER.

W następnym samouczku z tej serii samouczków Rest API zautomatyzujemy przypadki testowe, które wykonaliśmy ręcznie.

rekomendowane lektury

^