Meny

Rest API-responskoder og typer hvileanmodninger

  • Hoved
  • Annen
  • Rest API-responskoder og typer hvileanmodninger

rest api response codes

Prøv Instrumentet Vårt For Å Eliminere Problemer

I denne veiledningen vil vi lære om forskjellige REST-responskoder, typer REST-forespørsler og noen beste fremgangsmåter som skal følges :

I forrige opplæring, REST API Architecture And Constraints, har vi lært om webtjenester, REST Architecture, POSTMAN, etc.

Vi kan referere til REST APIs første opplæring for mer informasjon om dette.

Når du søker på et ord eller en frase i en søkemotor, sender søkemotoren forespørselen til webserveren. Webserveren returnerer en tresifret svarskode som indikerer statusen til forespørselen.

Forskjellige typer svarkoder og hvileanmodninger

Hva du vil lære:

Rest API-responskoder

Her er noen eksempler på svarskoder som vi normalt ser når vi utfører REST API-testing over POSTMAN eller over en hvilken som helst REST API-klient.

# 1) 100-serien
Dette er midlertidige svar

  • 100 Fortsett
  • 101 Bytte protokoller
  • 102 Behandling

# 2) 200-serien
Klienten godtar forespørselen og behandles vellykket på serveren.

beste programvaren for å klone en harddisk
  • 200 - OK
  • 201 - Laget
  • 202 - Akseptert
  • 203 - Ikke-autoritativ informasjon
  • 204 - Intet innhold
  • 205 - Tilbakestill innhold
  • 206 - Delvis innhold
  • 207 - Multistatus
  • 208 - Allerede rapportert
  • 226 - IM brukt

# 3) 300-serien
De fleste kodene relatert til denne serien er for URL-omdirigering.

  • 300 - Flere valg
  • 301 - Flyttet permanent
  • 302 - Funnet
  • 303 - Kontroller annet
  • 304 - Ikke endret
  • 305 - Bruk proxy
  • 306 - Bytt proxy
  • 307 - Midlertidig omdirigering
  • 308 - Permanent omdirigering

# 4) 400-serien
Disse er spesifikke for feil på klientsiden.

  • 400 Ugyldig forespørsel
  • 401 - Uautorisert
  • 402 - Betaling kreves
  • 403 Forbudt
  • 404 ikke funnet
  • 405 - Metoden er ikke tillatt
  • 406 - Ikke akseptabelt
  • 407 - Proxy-autentisering kreves
  • 408 - Be om tidsavbrudd
  • 409 - Konflikt
  • 410 - Borte
  • 411 - kreves lengde
  • 412 - Forutsetning mislyktes
  • 413 - Nyttelast for stor
  • 414 - URI for lenge
  • 415 - Medietype som ikke støttes
  • 416 - Rekkevidde ikke tilfredsstillende
  • 417 - Forventningen mislyktes
  • 418 - Jeg er en tekanne
  • 421 - Misviste forespørsel
  • 422 - Ubearbeidelig enhet
  • 423 - Låst
  • 424 - Mislykket avhengighet
  • 426 - Oppgradering kreves
  • 428 - Forutsetning kreves
  • 429 - For mange forespørsler
  • 431 - Be om overskriftsfelt for store
  • 451 - Ikke tilgjengelig av juridiske grunner

# 5) 500-serien
Disse er spesifikke for serversiden feil.

  • 500 - Intern serverfeil
  • 501 - Ikke implementert
  • 502 - Bad Gateway
  • 503 tjeneste utilgjengelig
  • 504 - Gateway Timeout
  • 505 - HTTP-versjon støttes ikke
  • 506 - Variant Forhandler også
  • 507 - Utilstrekkelig lagring
  • 508 - Loop Detected
  • 510 - Ikke utvidet
  • 511 - Nettverksgodkjenning kreves

Bortsett fra dette er det flere forskjellige koder som eksisterer, men de vil avvike oss fra vår nåværende diskusjon.

Ulike typer REST-forespørsler

Her vil vi diskutere hver metode for REST API sammen med samlingene.

MetodeBeskrivelse
LAPPSvært mye å sette, men det er mer som en mindre manipulering av ressursinnhold
FÅHent statuslinje, svartekst, topptekst osv.
HODESamme som GET, men bare hent statuslinje og topptekstseksjon
POSTUtfør forespørsel ved å bruke forespørsel nyttelast hovedsakelig i å opprette en post på serveren
SETTENyttig til å manipulere / oppdatere ressursen ved hjelp av Request payload
SLETTSletter informasjon knyttet til målressursen.
ALTERNATIVERBeskriv kommunikasjonsalternativene for målressursen

Merk: Det er så mange metoder som finnes, som vi kan bruke POSTMAN, men vi vil bare diskutere følgende metoder ved hjelp av POSTMAN.

Vi skal bruke en dummy URL for å demonstrere http://jsonplaceholder.typicode.com . Denne URL-en skal gi oss de ønskede svarene, men det blir ikke opprettet, modifisert på serveren.

# 1) FÅ

Forespørsel parametere:
Metode: FÅ
Be om URI: http://jsonplaceholder.typicode.com/posts
Spørsmålsparameter: id = 3;

Svar mottatt:
Svarstatuskode: 200 OK

Svarorgan :

Svarorgan

# 2) HODET

Forespørsel parametere:
Metode: HODE
Be om URI: http://jsonplaceholder.typicode.com/posts

HODE

# 3) POST

POST

# 4) PUT

SETTE

SLETT

# 5) ALTERNATIVER

Forespørsel parametere:
Metode: ALTERNATIVER
Be om URI: http://jsonplaceholder.typicode.com/
Overskrifter: Content-type = Application / JSON

ALTERNATIVER

# 6) PATCH

LAPP

Beste fremgangsmåter når du validerer et REST API

# 1) CRUD-operasjoner

Består av minst 4 angitte metoder og skal fungere i Web API.
FÅ, POST, PUT og SLETT.

# 2) Feilhåndtering

hvordan du fjerner en indeks fra en array-java

Mulige tips for API-forbrukere om feilen og hvorfor den har oppstått. Det skal også gi feilmeldinger på granulært nivå.

# 3) API-versjonering

Bruk bokstaven ‘v’ i URL-en for å betegne API-versjonen. For eksempel-

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

Tilleggsparameter på slutten av URL-en

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

# 4) Filtrering

Gjør det mulig for brukeren å spesifisere, velg ønskede data i stedet for å gi dem alle om gangen.
/ kontakt / sam? navn, alder, betegnelse, kontor
/ kontakter? limit = 25 & offset = 20

# 5) Sikkerhet

Tidsstempel i hver eneste API-forespørsel og respons. Bruk av access_token for å sikre at API blir påkalt av tillitspartene.

Oracle database intervju spørsmål og svar

# 6) Analytics

Å ha Analytics i REST API vil gi deg et godt innblikk i API under test, spesielt når antall hentede poster er veldig høyt.

# 7) Dokumentasjon

Riktig dokumentasjon skal gis slik at API-forbrukere kan bruke den og konsumere tjenestene effektivt.

# 8) URL-struktur

URL-strukturen skal forbli enkel, og en bruker skal kunne lese domenenavnet enkelt over den.

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

Operasjoner som skal utføres over Rest API bør også være veldig enkle å forstå og utføre.

For eksempel for en e-postklient:

FÅ: lese / innboks / meldinger - Henter listen over alle meldinger under innboksen
FÅ: lese / innboks / meldinger / 10 - Leser 10thmelding i innboksen
POST: create / inbox / folders - Opprett en ny mappe under innboksen
SLETT: Slett / spam / meldinger - Slett alle meldingene under spam-mappen
SETTE: mapper / innboks / undermappe - Oppdater informasjonen om undermappen under innboksen.

Konklusjon

Mange organisasjoner foretrekker å implementere REST Web API siden det er veldig enkelt å implementere, har mindre standarder og regler å følge, lett tilgjengelig, lett og lett å forstå. POSTMAN har sine fordeler når det brukes med RESTful API på grunn av dets brukervennlige brukergrensesnitt, brukervennlighet og test, raskere svarprosent og nye RUNNER-funksjon.

I neste opplæring i denne Rest API-opplæringsserien vil vi automatisere testtilfellene som vi har utført manuelt.

Anbefalt lesing

^