Menu

Kódy odozvy Rest API a typy žiadostí o odpočinok

  • Hlavná
  • Iné
  • Kódy odozvy Rest API a typy žiadostí o odpočinok

rest api response codes

Vyskúšajte Náš Nástroj Na Odstránenie Problémov

V tomto výučbe sa dozvieme o rôznych kódoch odpovede REST, typoch žiadostí REST a niektorých osvedčených postupoch, ktoré treba dodržiavať. :

V predchádzajúcom tutoriáli REST API Architecture And Constraints sme sa dozvedeli o webových službách, REST Architecture, POSTMAN, atď.

Viac informácií o tomto si môžeme pozrieť v prvom tutoriále REST API.

Kedykoľvek hľadáte akékoľvek slovo alebo frázu vo vyhľadávacom nástroji, vyhľadávací modul odošle požiadavku webovému serveru. Webový server vráti trojmiestny kód odpovede, ktorý označuje stav požiadavky.

Rôzne typy kódov odpovede a požiadaviek na odpočinok

Čo sa dozviete:

Kódy odozvy Rest API

Tu je niekoľko vzorových kódov odpovedí, ktoré bežne uvidíme pri vykonávaní testovania rozhrania REST API na serveri POSTMAN alebo na ľubovoľnom klientovi rozhrania REST API.

# 1) Séria 100
Toto sú dočasné odpovede

  • 100 Pokračujte
  • 101 Prepínacie protokoly
  • 102 Spracovanie

# 2) Séria 200
Klient akceptuje požiadavku, ktorá je úspešne spracovaná na serveri.

ba otázky, ktoré sa treba opýtať na pohovore
  • 200 - OK
  • 201 - Vytvorené
  • 202 - prijaté
  • 203 - Neautoritatívne informácie
  • 204 - Žiadny obsah
  • 205 - Obnoviť obsah
  • 206 - Čiastočný obsah
  • 207 - Multi-Status
  • 208 - Už je nahlásené
  • 226 - Použité IM

# 3) Séria 300
Väčšina kódov súvisiacich s touto sériou je určená na presmerovanie adries URL.

  • 300 - Viac možností
  • 301 - trvale presunuté
  • 302 - nájdené
  • 303 - Skontrolujte ďalšie
  • 304 - nezmenené
  • 305 - použite proxy server
  • 306 - Prepnúť proxy
  • 307 - Dočasné presmerovanie
  • 308 - Trvalé presmerovanie

# 4) Séria 400
Sú špecifické pre chyby na strane klienta.

  • 400 - zlá požiadavka
  • 401 - neoprávnené
  • 402 - Vyžaduje sa platba
  • 403 zakázané
  • 404 nenájdené
  • 405 - Metóda nie je povolená
  • 406 - neprijateľné
  • 407 - Vyžaduje sa autentifikácia proxy
  • 408 - Časový limit žiadosti
  • 409 - Konflikt
  • 410 - Preč
  • 411 - požadovaná dĺžka
  • 412 - Podmienka zlyhala
  • 413 - Príliš veľké užitočné zaťaženie
  • 414 - URI je príliš dlhý
  • 415 - Nepodporovaný typ média
  • 416 - Rozsah nie je uspokojivý
  • 417 - Očakávanie zlyhalo
  • 418 - som čajová kanvica
  • 421 - Nesprávna požiadavka
  • 422 - Nespracovateľný subjekt
  • 423 - Zamknuté
  • 424 - Zlyhaná závislosť
  • 426 - Vyžaduje sa upgrade
  • 428 - Vyžaduje sa podmienka
  • 429 - Príliš veľa požiadaviek
  • 431 - Vyžiadajte si príliš veľké polia hlavičky
  • 451 - Z právnych dôvodov nedostupné

# 5) Séria 500
Sú špecifické pre chybu na strane servera.

  • 500 - Interná chyba servera
  • 501 - Neimplementované
  • 502 - Bad Gateway
  • 503 služba nedostupná
  • 504 - Časový limit brány
  • 505 - Verzia HTTP nie je podporovaná
  • 506 - Variant tiež rokuje
  • 507 - Nedostatočné úložisko
  • 508 - zistená slučka
  • 510 - nepredlžené
  • 511 - Vyžaduje sa sieťové overenie

Okrem toho existuje niekoľko rôznych kódov, ktoré existujú, ale tie sa nás budú líšiť od našej súčasnej diskusie.

Iný typ požiadaviek REST

Tu budeme diskutovať o každej metóde REST API spolu so zbierkami.

MetódaPopis
PATCHVeľmi podobné, ako by sa dalo povedať, ale skôr sa jedná o malú manipuláciu so zdrojovým obsahom
ZÍSKAJTENačítať stavový riadok, telo odpovede, hlavička atď.
HLAVARovnaké ako GET, ale iba načítať stavový riadok a sekciu hlavičky
POSTŽiadosť vykonajte pomocou užitočného zaťaženia žiadosti, väčšinou pri vytváraní záznamu na serveri
PUTUžitočné pri manipulácii / aktualizácii zdroja pomocou požiadavky na užitočné zaťaženie
ODSTRÁNIŤVymaže informácie týkajúce sa cieľového zdroja.
MOŽNOSTIPopíšte možnosti komunikácie pre cieľový zdroj

Poznámka: Existuje toľko metód, ktoré môžeme urobiť pomocou programu POSTMAN, ale budeme diskutovať iba o nasledujúcich metódach pomocou programu POSTMAN.

Na demonštráciu použijeme fiktívnu adresu URL http://jsonplaceholder.typicode.com . Táto adresa URL nám poskytne požadované odpovede, ale na serveri nedôjde k žiadnemu vytvoreniu alebo zmene.

# 1) ZÍSKAJTE

Parametre požiadavky:
Metóda: ZÍSKAJTE
URI požiadavky: http://jsonplaceholder.typicode.com/posts
Parameter dopytu: id = 3;

Prijatá odpoveď:
Kód stavu odpovede: 200 OK

Orgán reakcie :

Orgán reakcie

# 2) HLAVA

Parametre požiadavky:
Metóda: HLAVA
URI požiadavky: http://jsonplaceholder.typicode.com/posts

HLAVA

# 3) POST

POST

# 4) PUT

PUT

ODSTRÁNIŤ

# 5) MOŽNOSTI

Parametre požiadavky:
Metóda: MOŽNOSTI
URI požiadavky: http://jsonplaceholder.typicode.com/
Hlavičky: Content-type = Application / JSON

MOŽNOSTI

# 6) PATCH

PATCH

kto je najlepším poskytovateľom e-mailov

Osvedčené postupy pri overovaní rozhrania REST API

# 1) Operácie CRUD

Skladá sa z minimálne 4 poskytnutých metód a malo by fungovať vo webovom rozhraní API.
GET, POST, PUT a DELETE.

# 2) Spracovanie chýb

Možné rady pre spotrebiteľov API o chybe a o tom, prečo k nej došlo. Tiež by mal poskytovať chybové správy na granulárnej úrovni.

# 3) Správa verzií API

Použite písmeno „v“ v adrese URL na označenie verzie API. Napríklad-

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

Ďalší parameter na konci adresy URL

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

# 4) Filtrovanie

Umožnenie používateľovi určiť, vybrať požadované údaje namiesto poskytovania všetkých naraz.
/ kontakt / sam? meno, vek, označenie, kancelária
/ kontakty? limit = 25 & offset = 20

# 5) Zabezpečenie

Časová značka v každej žiadosti a odpovedi na API. Používanie parametra access_token na zabezpečenie toho, aby si dôveryhodné strany vyvolávali API.

najlepšie zadarmo DVD Ripper pre šifrované DVD

# 6) Analýza

Vďaka analýze v rozhraní REST API získate dobrý prehľad o testovanom rozhraní API, najmä keď je počet načítaných záznamov veľmi vysoký.

# 7) Dokumentácia

Je potrebné poskytnúť náležitú dokumentáciu, aby ju spotrebitelia API mohli používať a efektívne využívať služby.

# 8) Štruktúra URL

Štruktúra adresy URL by mala zostať jednoduchá a používateľ by mal byť schopný ľahko nad ňou prečítať názov domény.

Napríklad , https://api.testdomain.com.

Operácie, ktoré sa majú vykonať cez rozhranie Rest API, by tiež mali byť veľmi ľahko pochopiteľné a uskutočniteľné.

Napríklad pre e-mailového klienta:

ZÍSKAJTE: prečítané / doručené správy / správy - Načíta zoznam všetkých správ v doručenej pošte
ZÍSKAJTE: čítanie / doručená pošta / správy / 10 - čítanie 10thspráva v doručenej pošte
POST: create / inbox / folders - Vytvorte nový priečinok v priečinku doručenej pošty
ODSTRÁNIŤ: Odstrániť / spam / správy - Odstráni všetky správy v priečinku spam
PUT: Priečinky / Doručené / Podpriečinok - Aktualizujte informácie týkajúce sa podpriečinka v priečinku Doručená pošta.

Záver

Mnoho organizácií uprednostňuje implementáciu REST Web API, pretože je veľmi ľahko implementovateľná, má nižšie štandardy a pravidlá, ktoré treba dodržiavať, je ľahký prístup, ľahká a ľahko pochopiteľná. POSTMAN má svoje výhody pri použití s ​​RESTful API vďaka užívateľsky prívetivému používateľskému rozhraniu, ľahkému použitiu a testovaniu, rýchlejšej odozve a novej funkcii RUNNER.

V nasledujúcom tutoriáli v tejto sérii výučbových programov pre API automatizujeme testovacie prípady, ktoré sme vykonali manuálne.

Odporúčané čítanie

^