Kódy odezvy REST API a typy žádostí o odpočinek

rest api response codes

V tomto výukovém programu se dozvíte o různých kódech odezvy REST, typech požadavků REST a některých osvědčených postupech, které je třeba dodržovat. :

V předchozím tutoriálu REST API Architecture And Constraints jsme se dozvěděli o webových službách, REST Architecture, POSTMANU atd.

Můžeme se podívat na první tutoriál REST API, kde najdete další informace.

Kdykoli vyhledáváte jakékoli slovo nebo frázi ve vyhledávači, vyhledávač odešle požadavek na webový server. Webový server vrací tříciferný kód odpovědi, který označuje stav požadavku.

Co se naučíte:

• Kódy odezvy rest API
• Jiný typ požadavků REST
  • # 1) ZÍSKEJTE
  • # 2) HLAVA
  • # 3) POST
  • # 4) PUT
  • # 5) MOŽNOSTI
  • # 6) PATCH
• Osvědčené postupy při ověřování REST API
• Závěr
  • Doporučené čtení

Kódy odezvy rest API

Zde je několik ukázkových kódů odpovědí, které obvykle uvidíme při provádění testování REST API přes POSTMAN nebo přes libovolného klienta REST API.

# 1) Řada 100
Jedná se o dočasné odpovědi

• 100 Pokračovat
• 101 Přepínací protokoly
• 102 Zpracování

# 2) Řada 200
Klient přijímá požadavek, který je úspěšně zpracován na serveru.

dobrý blokování vyskakovacích oken pro chrom

• 200 - OK
• 201 - Vytvořeno
• 202 - přijato
• 203 - Neautoritativní informace
• 204 - Žádný obsah
• 205 - Obnovit obsah
• 206 - Částečný obsah
• 207 - Multi-Status
• 208 - Již nahlášeno
• 226 - IM použito

# 3) Řada 300
Většina kódů souvisejících s touto sérií je určena pro přesměrování URL.

• 300 - více možností
• 301 - Trvale přesunuto
• 302 - nalezeno
• 303 - Zkontrolovat jiné
• 304 - beze změny
• 305 - Použijte proxy
• 306 - Přepnout proxy
• 307 - Dočasné přesměrování
• 308 - Trvalé přesměrování

# 4) Řada 400
Jedná se o specifické chyby na straně klienta.

• 400 - Špatný požadavek
• 401 - Neoprávněné
• 402 - Vyžaduje se platba
• 403 Přístup odepřen
• 404 nenalezeno
• 405 - Metoda není povolena
• 406 - nepřijatelné
• 407 - Vyžaduje se ověření serveru proxy
• 408 - Časový limit požadavku
• 409 - Konflikt
• 410 - Pryč
• 411 - požadovaná délka
• 412 - Předpoklad selhal
• 413 - Užitečné zatížení je příliš velké
• 414 - URI příliš dlouhý
• 415 - Nepodporovaný typ média
• 416 - Dosah není uspokojivý
• 417 - Očekávání se nezdařilo
• 418 - Jsem čajová konvice
• 421 - Nesprávně nasměrovaný požadavek
• 422 - Nezpracovatelná entita
• 423 - Zamčeno
• 424 - Selhání závislosti
• 426 - Vyžaduje se upgrade
• 428 - Je nutná podmínka
• 429 - Příliš mnoho žádostí
• 431 - Žádost o pole záhlaví je příliš velká
• 451 - Nedostupné z právních důvodů

# 5) Řada 500
Jedná se o konkrétní chybu na straně serveru.

• 500 - Interní chyba serveru
• 501 - Neimplementováno
• 502 - Bad Gateway
• 503 služba nedostupná
• 504 - Časový limit brány
• 505 - Verze HTTP není podporována
• 506 - Varianta také vyjednává
• 507 - Nedostatečné úložiště
• 508 - detekována smyčka
• 510 - Není rozšířeno
• 511 - Vyžaduje se síťové ověření

Kromě toho existuje několik různých kódů, které existují, ale ty nás odchýlí od naší současné diskuse.

Jiný typ požadavků REST

Zde budeme diskutovat o každé metodě REST API spolu s kolekcemi.

Poznámka: Existuje tolik metod, které existují, které můžeme udělat pomocí POSTMAN, ale budeme diskutovat pouze o následujících metodách pomocí POSTMAN.

K prokázání použijeme fiktivní adresu URL http://jsonplaceholder.typicode.com . Tato adresa URL nám poskytne požadované odpovědi, ale na serveru nedojde k žádnému vytváření ani úpravám.

# 1) ZÍSKEJTE

Parametry požadavku:
Metoda: ZÍSKEJTE
URI požadavku: http://jsonplaceholder.typicode.com/posts
Parametr dotazu: id = 3;

Přijatá odpověď:
Stavový kód odpovědi: 200 OK

Tělo odpovědi :

# 2) HLAVA

Parametry požadavku:
Metoda: HLAVA
URI požadavku: http://jsonplaceholder.typicode.com/posts

# 3) POST

# 4) PUT

# 5) MOŽNOSTI

Parametry požadavku:
Metoda: MOŽNOSTI
URI požadavku: http://jsonplaceholder.typicode.com/
Záhlaví: Content-type = Application / JSON

# 6) PATCH

Osvědčené postupy při ověřování REST API

# 1) CRUD operace

Skládá se z minimálně 4 poskytovaných metod a mělo by fungovat ve webovém rozhraní API.
GET, POST, PUT a DELETE.

# 2) Zpracování chyb

Možné rady pro spotřebitele API o chybě a proč k ní došlo. Rovněž by měl poskytovat chybové zprávy na granulární úrovni.

# 3) Správa verzí API

jaké typy e-mailů existují

K označení verze API použijte písmeno „v“ v adrese URL. Například-

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

Další parametr na konci adresy URL

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

# 4) Filtrování

Umožní uživateli určit, vyberte požadovaná data, místo aby poskytovala všechny najednou.
/ kontakt / sam? jméno, věk, označení, kancelář
/ kontakty? limit = 25 & offset = 20

# 5) Zabezpečení

Časové razítko v každé žádosti a odpovědi API. Použití access_token k zajištění toho, aby strany důvěryhodnosti vyvolaly API.

jak si vytvoříte falešnou e-mailovou adresu

# 6) Analytics

Díky Analytics ve vašem REST API získáte dobrý přehled o testovaném API, zvláště když je počet načtených záznamů velmi vysoký.

# 7) Dokumentace

Je třeba poskytnout řádnou dokumentaci, aby ji spotřebitelé API mohli používat a efektivně využívat služby.

# 8) Struktura URL

Struktura URL by měla zůstat jednoduchá a uživatel by měl být schopen snadno přečíst název domény.

Například , https://api.testdomain.com.

Operace prováděné přes rozhraní Rest API by také měly být velmi snadno pochopitelné a proveditelné.

Například pro e-mailového klienta:

DOSTAT: čtení / doručená pošta / zprávy - Načte seznam všech zpráv ve složce doručené pošty
DOSTAT: read / inbox / messages / 10 - Přečte 10^thzpráva v doručené poště
POŠTA: create / inbox / folders - Vytvořit novou složku v doručené poště
VYMAZAT: Odstranit / spam / zprávy - Odstraní všechny zprávy ve složce spamu
DÁT: složky / Doručená pošta / podsložka - Aktualizujte informace týkající se podsložky ve složce Doručená pošta.

Závěr

Mnoho organizací upřednostňuje implementaci REST Web API, protože je velmi snadné jej implementovat, má nižší standardy a pravidla, která je třeba dodržovat, snadný přístup, lehký a snadno pochopitelný. POSTMAN má své výhody při použití s ​​RESTful API díky uživatelsky přívětivému uživatelskému rozhraní, snadnému použití a testování, rychlejší odezvě a nové funkci RUNNER.

V dalším výukovém programu v této sérii výukového programu Rest API budeme automatizovat testovací případy, které jsme provedli ručně.

Doporučené čtení

• Jak automatizovat požadavky API pomocí klidného a Jenkinse
• Testování REST API s okurkou pomocí přístupu BDD
• 10 nejlepších nástrojů pro testování API v roce 2021 (nástroje pro testování API SOAP a REST)
• Testování REST API s Spring RestTemplate a TestNG
• Jak vytvořit projekt REST v SoapUI Pro: Výukový program č. 13
• Práce s požadavky HTTP v JMeteru
• Druhy rizik v softwarových projektech
• Rozdíl SOAP Vs REST: Porovnání výkonu a zabezpečení