Meny

Rest API-svarskoder och typer av vilovärden

  • Huvud
  • Övrig
  • Rest API-svarskoder och typer av vilovärden

rest api response codes

Prova Vårt Instrument För Att Eliminera Problem

I den här självstudien kommer vi att lära oss om olika REST-svarskoder, typer av REST-förfrågningar och några bästa metoder som ska följas :

I föregående handledning, REST API Architecture And Constraints, har vi lärt oss om webbtjänster, REST Architecture, POSTMAN, etc.

Vi kan hänvisa till REST API: s första handledning för mer information om detta.

När du söker efter något ord eller fraser i en sökmotor skickar sökmotorn begäran till webbservern. Webbservern returnerar en tresiffrig svarkod som anger begäran.

Olika typer av svarskoder och viloperationer

Vad du kommer att lära dig:

Rest API-svarskoder

Här är några svarkoder som vi normalt ser när vi utför REST API-testning över POSTMAN eller över någon REST API-klient.

# 1) 100-serien
Dessa är tillfälliga svar

  • 100 Fortsätt
  • 101 Byta protokoll
  • 102 Bearbetning

# 2) 200-serien
Klienten accepterar begäran och behandlas framgångsrikt på servern.

youtube till mp3-omvandlare hög kvalitet gratis nedladdning
  • 200 - OK
  • 201 - Skapad
  • 202 - Accepterat
  • 203 - Obehörig information
  • 204 - Inget innehåll
  • 205 - Återställ innehåll
  • 206 - Delvis innehåll
  • 207 - Multi-Status
  • 208 - Redan rapporterad
  • 226 - IM används

# 3) 300-serien
De flesta koder relaterade till denna serie är avsedda för URL-omdirigering.

  • 300 - Flera val
  • 301 flyttade permanent
  • 302 - Hittade
  • 303 - Kontrollera Annat
  • 304 - Ej modifierad
  • 305 - Använd proxy
  • 306 - Växla proxy
  • 307 - Tillfällig omdirigering
  • 308 - Permanent omdirigering

# 4) 400-serien
Dessa är specifika för fel på klientsidan.

  • 400 Dålig Förfrågan
  • 401 - Obehörig
  • 402 - Betalning krävs
  • 403 - Förbjudet
  • 404 Ej Hittad
  • 405 - Metoden är inte tillåten
  • 406 - Inte godtagbart
  • 407 - Proxyverifiering krävs
  • 408 - Timeout för begäran
  • 409 - Konflikt
  • 410 - Borta
  • 411 - Längd krävs
  • 412 - Förutsättningen misslyckades
  • 413 - För stor nyttolast
  • 414 - URI för länge
  • 415 - Mediatyp som inte stöds
  • 416 - Räckvidd inte tillfredsställande
  • 417 - Förväntningen misslyckades
  • 418 - Jag är en tekanna
  • 421 - Felaktig begäran
  • 422 - Obehandlad enhet
  • 423 - Låst
  • 424 - Misslyckat beroende
  • 426 - Uppgradering krävs
  • 428 - Förutsättning krävs
  • 429 - För många begäranden
  • 431 - Begär rubrikfält för stora
  • 451 - Ej tillgänglig av juridiska skäl

# 5) 500-serien
Dessa är specifika för serverns fel.

  • 500 - Internt serverfel
  • 501 - Inte implementerat
  • 502 - Bad Gateway
  • 503 Tjänst Otillgänglig
  • 504 Gateway Time-out
  • 505 - HTTP-version stöds inte
  • 506 - Variant förhandlar också
  • 507 - Otillräcklig lagring
  • 508 - Loop Detected
  • 510 - Inte förlängd
  • 511 - Nätverksautentisering krävs

Bortsett från detta finns det flera olika koder som finns men de kommer att avvika från vår nuvarande diskussion.

Olika typer av REST-begäranden

Här kommer vi att diskutera varje metod för REST API tillsammans med samlingarna.

MetodBeskrivning
LAPPAMycket liknar att sätta men det är mer som en mindre manipulation av resursinnehåll
SKAFFA SIGHämta statusrad, svarstecken, rubrik etc.
HUVUDSamma som GET, men bara hämta statusrad och rubrik
POSTAUtför begäran med hjälp av begäran nyttolast främst för att skapa en post på servern
SÄTTAAnvändbar för att manipulera / uppdatera resursen med hjälp av Begär nyttolast
RADERATar bort information som rör målresursen.
ALTERNATIVBeskriv kommunikationsalternativen för målresursen

Notera: Det finns så många metoder som finns, som vi kan göra med POSTMAN men vi kommer bara att diskutera följande metoder med POSTMAN.

Vi ska använda en dummy URL för att demonstrera http://jsonplaceholder.typicode.com . Denna URL ska ge oss de önskade svaren men det kommer inte att skapas, modifieras på servern.

hur man hittar nätverkssäkerhetsnyckel på Windows 10

# 1) FÅ

Begär parametrar:
Metod: FÅ
Begär URI: http://jsonplaceholder.typicode.com/posts
Frågeparameter: id = 3;

Svar mottaget:
Svarsstatuskod: 200 OK

Svarsorgan :

Svarsorgan

# 2) HUVUD

Begär parametrar:
Metod: HEAD
Begär URI: http://jsonplaceholder.typicode.com/posts

HUVUD

# 3) POST

POSTA

# 4) PUT

SÄTTA

RADERA

# 5) ALTERNATIV

Begär parametrar:
Metod: ALTERNATIV
Begär URI: http://jsonplaceholder.typicode.com/
Rubriker: Content-type = Application / JSON

ALTERNATIV

# 6) PATCH

LAPPA

Bästa metoder när du validerar ett REST-API

# 1) CRUD-operationer

Består av minst fyra metoder som tillhandahålls och ska fungera i webb-API.
GET, POST, PUT och DELETE.

# 2) Felhantering

Möjliga tips för API-konsumenter om felet och varför det har inträffat. Det bör också ge granulära felmeddelanden.

# 3) API-versionering

Använd bokstaven ”v” i webbadressen för att beteckna API-versionen. Till exempel-

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

Ytterligare parameter i slutet av webbadressen

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

# 4) Filtrering

Gör det möjligt för användaren att specificera, välj önskad data istället för att ge dem alla åt gången.
/ kontakt / sam? namn, ålder, beteckning, kontor
/ kontakter? limit = 25 & offset = 20

# 5) Säkerhet

Tidsstämpel i varje API-begäran och svar. Användning av access_token för att säkerställa att API åberopas av förtroendeparterna.

hur man öppnar apk-filer på Windows

# 6) Analys

Att ha Analytics i ditt REST API ger dig en god inblick i API under test, särskilt när antalet poster som hämtas är mycket högt.

# 7) Dokumentation

Korrekt dokumentation ska tillhandahållas så att API-konsumenter kan använda den och konsumera tjänsterna effektivt.

# 8) URL-struktur

URL-strukturen ska förbli enkel och en användare bör kunna läsa domännamnet lätt över den.

Till exempel , https://api.testdomain.com.

Operationer som ska utföras via Rest API bör också vara mycket lätta att förstå och utföra.

Till exempel för en e-postklient:

SKAFFA SIG: läs / inkorg / meddelanden - Hämtar listan över alla meddelanden under inkorgen
SKAFFA SIG: läs / inkorg / meddelanden / 10 - Läser 10thmeddelande i inkorgen
POSTA: skapa / inkorg / mappar - Skapa en ny mapp under inkorgen
RADERA: Radera / skräppost / meddelanden - Ta bort alla meddelanden i skräppostmappen
SÄTTA: mappar / inkorg / undermapp - Uppdatera informationen om undermappen under inkorgen.

Slutsats

Många organisationer föredrar att implementera REST Web API eftersom det är mycket enkelt att implementera, har mindre standarder och regler att följa, lätt att komma åt, lätt och lätt att förstå. POSTMAN har sina fördelar när det används med RESTful API på grund av dess användarvänliga användargränssnitt, användarvänlighet och test, snabbare svarsfrekvens och nya RUNNER-funktion.

I nästa handledning i denna Rest API Tutorial-serie kommer vi att automatisera de testfall som vi har utfört manuellt.

Rekommenderad läsning

^