apiPraktische tips voor Api


Invoering

Dit zijn enkele API Best Practices die ik had gebruikt.

parameters

Parameter Details
soort Sorteren op enkele of meerdere kolommen. sort=email,name
dir Oplopend / aflopend sorteren. dir=asc of dir=desc
kolom Filteren op. phone=5555555555
limiet Artikelen per pagina. limit=25
bladzijde Paginanummer. page=2
API sleutel API sleutel. api_key=ABCDEF1234567890

Opmerkingen

Statuscodes

1xx: informatie

Bericht Beschrijving lange beschrijving
100 Doorgaan met De server heeft de headers van het verzoek ontvangen en de client moet de body van het verzoek verzenden
101 Schakelprotocollen De aanvrager heeft de server gevraagd om van protocol te wisselen
103 Checkpoint Gebruikt in het voorstel voor hervatbare verzoeken om afgebroken PUT- of POST-aanvragen te hervatten

2xx: succesvol

Bericht Beschrijving lange beschrijving
200 OK De aanvraag is OK (dit is de standaardreactie voor succesvolle HTTP-aanvragen)
201 gemaakt Aan het verzoek is voldaan en er is een nieuwe resource gemaakt
202 Geaccepteerd Het verzoek is geaccepteerd voor verwerking, maar de verwerking is niet voltooid
203 Niet-gezaghebbende informatie Het verzoek is succesvol verwerkt, maar retourneert informatie die van een andere bron kan zijn
204 Geen inhoud Het verzoek is verwerkt, maar er wordt geen inhoud geretourneerd
205 Inhoud opnieuw instellen De aanvraag is verwerkt, maar retourneert geen inhoud en vereist dat de aanvrager de documentweergave opnieuw instelt
206 Gedeeltelijke inhoud De server levert slechts een deel van de bron vanwege een bereikkop die door de client is verzonden

3xx: omleiding

Bericht Beschrijving lange beschrijving
300 Meerdere keuzes Een linklijst. De gebruiker kan een link selecteren en naar die locatie gaan. Maximaal vijf adressen
301 permanent verhuisd De gevraagde pagina is verplaatst naar een nieuwe URL
302 gevonden De gevraagde pagina is tijdelijk verplaatst naar een nieuwe URL
303 Zie andere De gevraagde pagina is te vinden onder een andere URL
304 Niet aangepast Geeft aan dat de gevraagde pagina niet is gewijzigd sinds de laatste aanvraag
306 Schakel van proxy Niet langer gebruikt
307 Tijdelijke omleiding De gevraagde pagina is tijdelijk verplaatst naar een nieuwe URL
308 Hervat onvolledig Gebruikt in het voorstel voor hervatbare verzoeken om afgebroken PUT- of POST-aanvragen te hervatten

4xx: clientfout

Bericht Beschrijving lange beschrijving
400 Foute aanvraag Aan het verzoek kan niet worden voldaan vanwege een slechte syntaxis
401 onbevoegd Het verzoek was een wettelijk verzoek, maar de server weigert erop te reageren. Voor gebruik wanneer authenticatie mogelijk is maar is mislukt of nog niet is verstrekt
402 Betaling Vereist Gereserveerd voor toekomstig gebruik
403 Verboden Het verzoek was een wettelijk verzoek, maar de server weigert erop te reageren
404 Niet gevonden De gevraagde pagina kan niet worden gevonden, maar is in de toekomst mogelijk weer beschikbaar
405 methode niet toegestaan Er is een aanvraag gedaan voor een pagina met een aanvraagmethode die niet door die pagina wordt ondersteund
406 Niet acceptabel De server kan alleen een reactie genereren die niet door de client wordt geaccepteerd
407 Proxyverificatie vereist De client moet zichzelf eerst verifiëren met de proxy
408 Verzoek time-out Er is een time-out opgetreden voor de server op het verzoek
409 Conflict Het verzoek kan niet worden voltooid vanwege een conflict in het verzoek
410 Weg De gevraagde pagina is niet langer beschikbaar
411 Vereiste lengte De "Content-Length" is niet gedefinieerd. De server accepteert het verzoek zonder dit niet
412 Voorwaarde mislukt De voorwaarde die in de aanvraag is opgegeven, wordt door de server als onwaar geëvalueerd
413 Verzoekentiteit te groot De server accepteert het verzoek niet, omdat de verzoekentiteit te groot is
414 Aanvraag-URI te lang De server accepteert het verzoek niet, omdat de URL te lang is. Treedt op wanneer u een POST-verzoek omzet in een GET-verzoek met een lange query-informatie
415 Niet-ondersteund mediatype De server accepteert het verzoek niet, omdat het mediatype niet wordt ondersteund
416 Gevraagd bereik Niet bevredigend De client heeft om een gedeelte van het bestand gevraagd, maar de server kan dat gedeelte niet leveren
417 Verwachting mislukt De server kan niet voldoen aan de vereisten van het veld Verzoek-header verwachten

5xx: Serverfout

Bericht Beschrijving lange beschrijving
500 Interne Server Fout Een generiek foutbericht, gegeven wanneer geen specifiek bericht meer geschikt is
501 Niet geïmplementeerd De server herkent de aanvraagmethode niet of mist de mogelijkheid om aan de aanvraag te voldoen
502 Slechte gateway De server fungeerde als gateway of proxy en ontving een ongeldige reactie van de upstream-server
503 Service onbeschikbaar De server is momenteel niet beschikbaar (overbelast of down)
504 Gateway time-out De server fungeerde als gateway of proxy en ontving geen tijdige reactie van de upstream-server
505 HTTP-versie niet ondersteund De server ondersteunt de HTTP-protocolversie die in de aanvraag wordt gebruikt niet
511 Netwerkverificatie vereist De client moet worden geverifieerd om netwerktoegang te krijgen

Referentie: HTTP-codes

Praktische tips voor Api Gerelateerde voorbeelden