Menu

Rest API-responskoder og typer af hvileanmodninger

rest api response codes

Prøv Vores Instrument Til At Fjerne Problemer

I denne vejledning lærer vi om forskellige REST-responskoder, typer af REST-anmodninger og nogle af de bedste fremgangsmåder, der skal følges :

I den forrige tutorial, REST API Architecture And Constraints, har vi lært om webtjenester, REST Architecture, POSTMAN osv.

Vi kan muligvis henvise til REST API's første tutorial for mere information om dette.

Når du søger på et ord eller en sætning i en søgemaskine, sender søgemaskinen anmodningen til webserveren. Webserveren returnerer en trecifret svarskode, der angiver status for anmodningen.

Forskellige typer reaktionskoder og anmodninger om hvile

Hvad du lærer:

Rest API-svarskoder

Her er nogle eksempler på svarskoder, som vi normalt ser, når vi udfører REST API-test over POSTMAN eller over enhver REST API-klient.

# 1) 100-serien
Disse er midlertidige svar

  • 100 Fortsæt
  • 101 Skift af protokoller
  • 102 Behandling

# 2) 200-serien
Klienten accepterer anmodningen og behandles med succes på serveren.

websteder til download af youtube-videoer til mp3
  • 200 - OK
  • 201 - Oprettet
  • 202 - Accepteret
  • 203 - Ikke-autoritativ information
  • 204 - Intet indhold
  • 205 - Nulstil indhold
  • 206 - Delvist indhold
  • 207 - Multistatus
  • 208 - Allerede rapporteret
  • 226 - IM brugt

# 3) 300-serien
De fleste koder relateret til denne serie er til URL-omdirigering.

  • 300 - Flere valg
  • 301 - Flyttet permanent
  • 302 - Fundet
  • 303 - Kontroller andet
  • 304 - Ikke ændret
  • 305 - Brug proxy
  • 306 - Skift proxy
  • 307 - Midlertidig omdirigering
  • 308 - Permanent omdirigering

# 4) 400-serien
Disse er specifikke for klientsidesfejl.

  • 400 - Dårlig anmodning
  • 401 - Uautoriseret
  • 402 - Betaling påkrævet
  • 403 forbudt
  • 404 Ikke fundet
  • 405 - Metode ikke tilladt
  • 406 - Ikke acceptabelt
  • 407 - Proxy-godkendelse påkrævet
  • 408 - Timeout for anmodning
  • 409 - Konflikt
  • 410 - Borte
  • 411 - krævet længde
  • 412 - Forudsætning mislykkedes
  • 413 - Nyttelast for stor
  • 414 - URI for lang
  • 415 - Medietype, der ikke understøttes
  • 416 - Rækkevidde ikke tilfredsstillende
  • 417 - Forventningen mislykkedes
  • 418 - Jeg er en tekande
  • 421 - Fejlagtig anmodning
  • 422 - Ubearbejdelig enhed
  • 423 - Låst
  • 424 - Mislykket afhængighed
  • 426 - Opgradering påkrævet
  • 428 - Krævet forudsætning
  • 429 - For mange anmodninger
  • 431 - Anmodning om overskriftsfelter for store
  • 451 - Ikke tilgængelig af juridiske grunde

# 5) 500-serien
Disse er specifikke for serverfejlen.

  • 500 - Intern serverfejl
  • 501 - Ikke implementeret
  • 502 - Dårlig gateway
  • 503 Service ikke tilgængelig
  • 504 - Gateway-timeout
  • 505 - HTTP-version understøttes ikke
  • 506 - Variant Forhandler også
  • 507 - Utilstrækkelig opbevaring
  • 508 - Loop opdaget
  • 510 - Ikke udvidet
  • 511 - Netværksgodkendelse påkrævet

Bortset fra dette er der flere forskellige koder, der findes, men de vil afvige os fra vores nuværende diskussion.

Forskellig type REST-anmodninger

Her vil vi diskutere hver eneste metode til REST API sammen med samlingerne.

MetodeBeskrivelse
LAPPEMeget ligner at sætte, men det ligner mere en mindre manipulation af ressourceindhold
FÅHent statuslinje, svartekst, overskrift osv.
HOVEDSamme som GET, men kun hente statuslinje og overskriftssektion
STOLPEUdfør anmodning ved hjælp af anmodningsnyttelast for det meste ved oprettelse af en post på serveren
SÆTTENyttigt til at manipulere / opdatere ressourcen ved hjælp af Request payload
SLETSletter oplysninger vedrørende målressourcen.
MULIGHEDERBeskriv kommunikationsmulighederne for målressourcen

Bemærk: Der er så mange metoder, der findes, som vi kan gøre ved hjælp af POSTMAN, men vi vil kun diskutere følgende metoder ved hjælp af POSTMAN.

Vi skal bruge en dummy URL til at demonstrere http://jsonplaceholder.typicode.com . Denne URL skal give os de ønskede svar, men der vil ikke være nogen oprettelse, ændringer på serveren.

# 1) FÅ

Anmodningsparametre:
Metode: FÅ
Anmod URI: http://jsonplaceholder.typicode.com/posts
Forespørgselsparameter: id = 3;

Svar modtaget:
Svarstatuskode: 200 OK

Reaktionsorgan :

Reaktionsorgan

# 2) HOVED

Anmodningsparametre:
Metode: HOVED
Anmod URI: http://jsonplaceholder.typicode.com/posts

HOVED

# 3) POST

STOLPE

# 4) SÆT

SÆTTE

SLET

# 5) INDSTILLINGER

Anmodningsparametre:
Metode: VALGMULIGHEDER
Anmod URI: http://jsonplaceholder.typicode.com/
Overskrifter: Content-type = Application / JSON

MULIGHEDER

# 6) PATCH

LAPPE

hvordan man vender en array-java

Bedste fremgangsmåder ved validering af en REST API

# 1) CRUD-operationer

Består af mindst 4 tilvejebragte metoder og skal arbejde i Web API.
FÅ, POST, PUT og SLET.

# 2) Fejlhåndtering

Mulige tip til API-forbrugere om fejlen, og hvorfor den er opstået. Det skal også give granulære fejlmeddelelser.

# 3) API-versionering

Brug bogstavet 'v' i URL'en til at betegne API-versionen. For eksempel-

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

Yderligere parameter i slutningen af ​​URL'en

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

# 4) Filtrering

Gør det muligt for brugeren at specificere, vælg de ønskede data i stedet for at give dem alle ad gangen.
/ kontakt / sam? navn, alder, betegnelse, kontor
/ kontakter? limit = 25 & offset = 20

# 5) Sikkerhed

Tidsstempel i hver eneste API-anmodning og -svar. Brug af access_token for at sikre, at API påberåbes af tillidspartierne.

hvordan man spiller mkv på pc

# 6) Analyse

At have Analytics i din REST API giver dig et godt indblik i API under test, især når antallet af hentede poster er meget højt.

# 7) Dokumentation

Korrekt dokumentation skal leveres, så API-forbrugere kan bruge den og forbruge tjenesterne effektivt.

# 8) URL-struktur

URL-struktur skal forblive enkel, og en bruger skal være i stand til let at læse domænenavnet over det.

For eksempel , https://api.testdomain.com.

Operationer, der skal udføres over Rest API, skal også være meget lette at forstå og udføre.

For eksempel for en e-mail-klient:

FÅ: læse / indbakke / meddelelser - Henter listen over alle meddelelser under indbakken
FÅ: læse / indbakke / beskeder / 10 - Læser 10thbesked i indbakken
STOLPE: Opret / indbakke / mapper - Opret en ny mappe under indbakken
SLET: Slet / spam / beskeder - Slet alle beskeder under spam-mappen
SÆTTE: mapper / indbakke / undermappe - Opdater oplysningerne om undermappen under indbakke.

Konklusion

Mange organisationer foretrækker at implementere REST Web API, da det er meget let at implementere, har mindre standarder og regler at følge, let at få adgang til, let og let at forstå. POSTMAN har sine fordele, når det bruges med RESTful API på grund af dets brugervenlige brugergrænseflade, brugervenlighed og test, hurtigere svarprocent og nye RUNNER-funktion.

I den næste tutorial i denne Rest API Tutorial-serie automatiserer vi de testsager, som vi har udført manuelt.

Anbefalet læsning

^