Kodovi odgovora na API za odmor i vrste zahtjeva za odmor

rest api response codes

U ovom vodiču naučit ćemo o različitim kodovima odgovora na REST, vrstama zahtjeva za REST i nekim najboljim praksama kojih se treba pridržavati :

U prethodnom uputstvu, REST API Architecture And Constraints, naučili smo o web uslugama, REST Architecture, POSTMAN, itd.

Za više informacija o tome možemo se obratiti prvom vodiču za REST API.

Kad god pretražite bilo koju riječ ili frazu u tražilici, tražilica šalje zahtjev web poslužitelju. Web poslužitelj vraća troznamenkasti kod odgovora koji označava status zahtjeva.

Što ćete naučiti:

• Šifre odgovora API-ja za odmor
• Drugačija vrsta ODMORNIH zahtjeva
  • # 1) GET
  • # 2) GLAVA
  • # 3) OBJAVI
  • # 4) STAVITE
  • # 5) OPCIJE
  • # 6) PATCH
• Najbolji postupci prilikom provjere valjanosti REST API-ja
• Zaključak
  • Preporučena literatura

Šifre odgovora API-ja za odmor

Evo nekoliko primjera kodova odgovora koje ćemo normalno vidjeti tijekom izvođenja testiranja REST API-ja preko POSTMAN-a ili bilo kojeg klijenta REST API-ja.

# 1) 100 serija
To su privremeni odgovori

• 100 Nastavite
• 101 Prebacivanje protokola
• 102 Obrada

# 2) Serija 200
Klijent prihvaća zahtjev, koji se uspješno obrađuje na poslužitelju.

kako napisati test slučajeve za web aplikaciju

• 200 - U redu
• 201 - Stvoreno
• 202 - Prihvaćen
• 203 - Neautoritativne informacije
• 204 - Nema sadržaja
• 205 - Poništi sadržaj
• 206 - Djelomični sadržaj
• 207 - Više statusa
• 208 - Već prijavljeno
• 226 - IM korišteno

# 3) Serija 300
Većina kodova povezanih s ovom serijom odnosi se na preusmjeravanje URL-ova.

• 300 - Višestruki izbor
• 301 - Premješteno trajno
• 302 - Pronađeno
• 303 - Provjeri ostalo
• 304 - Nije modificirano
• 305 - Koristite proxy
• 306 - Prebacivanje proxyja
• 307 - Privremena preusmjeravanja
• 308 - Trajna preusmjeravanja

# 4) 400 serija
To su specifične za pogreške na strani klijenta.

• 400 - Loš zahtjev
• 401 - Neovlašteno
• 402 - Potrebno plaćanje
• 403 Zabranjeno
• 404 nije pronađeno
• 405 - Metoda nije dopuštena
• 406 - Nije prihvatljivo
• 407 - Potrebna je provjera autentičnosti proxyja
• 408 - Istek zahtjeva
• 409 - Sukob
• 410 - Otišao
• 411 - Potrebna duljina
• 412 - Preduvjet nije uspio
• 413 - Korisni teret prevelik
• 414 - Predugo URI
• 415 - Nepodržana vrsta medija
• 416 - domet nije zadovoljavajući
• 417 - Očekivanje nije uspjelo
• 418 - Ja sam čajnik
• 421 - Pogrešno usmjeren zahtjev
• 422 - Neobradivi entitet
• 423 - zaključano
• 424 - Neuspjela ovisnost
• 426 - Potrebna nadogradnja
• 428 - Potreban preduvjet
• 429 - Previše zahtjeva
• 431 - Prevelika polja zaglavlja zahtjeva
• 451 - Nedostupno iz pravnih razloga

# 5) Serija 500
Oni su specifični za pogrešku na strani poslužitelja.

• 500 Interna pogreška poslužitelja
• 501 - Nije provedeno
• 502 - Bad Gateway
• 503 usluga nedostupna
• 504 - Isteklo vrijeme prolaza
• 505 - HTTP verzija nije podržana
• 506 - Varijanta također pregovara
• 507 - Nedovoljno prostora za pohranu
• 508 - Otkrivena petlja
• 510 - Nije produljeno
• 511 - Potrebna je mrežna provjera autentičnosti

Osim toga, postoji nekoliko različitih kodeksa koji postoje, ali oni će nas odvojiti od naše trenutne rasprave.

Drugačija vrsta ODMORNIH zahtjeva

Ovdje ćemo razgovarati o svakoj metodi REST API-ja zajedno sa kolekcijama.

Bilješka: Postoji toliko mnogo metoda koje možemo učiniti pomoću POSTMAN-a, ali razgovarat ćemo samo o sljedećim metodama pomoću POSTMAN-a.

Za demonstraciju ćemo koristiti lažni URL http://jsonplaceholder.typicode.com . Ovaj će nam URL dati željene odgovore, ali na poslužitelju neće biti nikakvih izrada ili izmjena.

# 1) GET

Parametri zahtjeva:
Metoda: GET
URI zahtjeva: http://jsonplaceholder.typicode.com/posts
Parametar upita: id = 3;

Primljeni odgovor:
Šifra statusa odgovora: 200 OK

Tijelo odgovora :

# 2) GLAVA

Parametri zahtjeva:
Metoda: GLAVA
URI zahtjeva: http://jsonplaceholder.typicode.com/posts

# 3) OBJAVI

koji je najbolji besplatni mp3 downloader za android

# 4) STAVITE

# 5) OPCIJE

Parametri zahtjeva:
Metoda: OPCIJE
URI zahtjeva: http://jsonplaceholder.typicode.com/
Zaglavlja: Content-type = Application / JSON

# 6) PATCH

Najbolji postupci prilikom provjere valjanosti REST API-ja

# 1) CRUD operacije

Sastoje se od najmanje 4 navedene metode i trebale bi raditi u web API-ju.
GET, POST, staviti i izbrisati.

# 2) Rukovanje pogreškama

Mogući savjeti za potrošače API-ja o pogrešci i zašto se dogodila. Također bi trebao pružati zrnaste poruke o pogreškama.

# 3) Izrada API-ja

Upotrijebite slovo 'v' u URL-u da biste označili verziju API-ja. Na primjer-

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

Dodatni parametar na kraju URL-a

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

# 4) Filtriranje

Omogućavajući korisniku da navede, odaberite željene podatke umjesto da ih pružate odjednom.
/ kontakt / sam? ime, dob, oznaka, ured
/ kontakti? limit = 25 & offset = 20

# 5) Sigurnost

Vremenska oznaka u svakom API zahtjevu i odgovoru. Upotreba access_token kako bi se osiguralo da se povjerljive stranke pozivaju na API.

najbolji besplatni DVD ripper za šifrirani DVD

# 6) Analitika

Ako imate Analytics u svom REST API-ju, dat ćete dobar uvid u API koji se testira, posebno kada je broj dohvaćenih zapisa vrlo velik.

# 7) Dokumentacija

Treba osigurati odgovarajuću dokumentaciju kako bi je korisnici API-ja mogli koristiti i učinkovito trošiti usluge.

# 8) URL struktura

Struktura URL-a trebala bi ostati jednostavna, a korisnik bi trebao moći lako čitati ime domene preko njega.

Na primjer , https://api.testdomain.com.

Operacije koje treba izvesti preko API-ja za odmor također bi trebale biti vrlo jednostavne za razumijevanje i izvođenje.

Na primjer, za klijenta e-pošte:

DOBITI: read / inbox / messages - Dohvaća popis svih poruka u mapi Primljeno
DOBITI: read / inbox / messages / 10 - čita 10^thporuka u pristigloj pošti
POŠTA: create / inbox / folders - stvorite novu mapu pod inbox
IZBRISATI: Izbriši / neželjenu poštu / poruke - izbrišite sve poruke iz mape neželjene pošte
STAVITI: mape / mapa pristigle pošte / podmapa - ažurirajte podatke koji se odnose na podmapu pod mapom Pristigla pošta.

Zaključak

Mnoge organizacije više vole implementirati REST Web API, jer je vrlo jednostavan za primjenu, ima manje standarde i pravila koja treba slijediti, lagan za pristup, lagan i razumljiv. POSTMAN ima svoje prednosti kada se koristi s RESTful API-jem zbog korisničkog korisničkog sučelja, jednostavnosti upotrebe i testiranja, bržeg odziva i nove značajke RUNNER.

U sljedećem uputstvu u ovoj seriji Vodiča za API za odmor automatizirat ćemo test slučajeve koje smo izvršili ručno.

Preporučena literatura

• Kako automatizirati zahtjeve za API korištenjem uvjerenih i Jenkinsa
• REST API ispitivanje krastavca korištenjem BDD pristupa
• 10 najboljih alata za testiranje API-ja 2021. godine (SOAP i REST API alati za testiranje)
• REST API testiranje s Spring RestTemplate i TestNG
• Kako stvoriti REST projekt u SoapUI Pro: Vodič br. 13
• Rad s HTTP zahtjevima u JMeteru
• Vrste rizika u softverskim projektima
• Razlika u SOAP-u protiv OSTALOG: Usporedba performansi i sigurnosti