← API REST : concevoir, mûrir, documenter

Verbes, codes, en-têtes — antisèche

Toutes les tables de référence du cours en un seul endroit : verbes HTTP, codes de statut, en-têtes courants, niveaux de Richardson et mots-clés OpenAPI.

Verbes HTTP

VerbeSur /usersSur /users/42SûrIdempotent
GETListerLire
POSTCréer(rare)
PUT(rare)Remplacer entièrement
PATCH(rare)Modifier partiellement
DELETE(rare)Supprimer

Codes de statut essentiels

CodeNomSens
200OKSuccès générique (GET, PUT, PATCH)
201CreatedPOST qui a créé une ressource
204No ContentSuccès sans corps (souvent DELETE)
400Bad RequestRequête mal formée
401UnauthorizedNon authentifié
403ForbiddenAuthentifié, mais non autorisé
404Not FoundRessource introuvable
409ConflictConflit avec l’état actuel
422Unprocessable EntityInvalide sémantiquement
429Too Many RequestsLimite de débit dépassée
500Internal Server ErrorErreur côté serveur

En-têtes HTTP courants

En-têteUsage
Authorization: Bearer <jeton>Authentification (API key, JWT)
Content-Type: application/jsonFormat du corps envoyé
Accept: application/jsonFormat attendu en réponse
Location: /users/43URI de la ressource créée (avec 201)
ETag / If-None-MatchCache conditionnel

Les 4 niveaux de Richardson

NiveauNomCe qui le caractérise
0Tunnel POX/RPCUne seule URI, un seul verbe (POST), action dans le corps
1RessourcesUne URI par ressource, verbe encore figé (souvent POST)
2Verbes HTTPLe verbe HTTP porte l’action ; codes de statut porteurs de sens
3HATEOASLes réponses contiennent des liens vers les actions possibles

Mots-clés OpenAPI (v3.1)

CléRôle
openapiVersion de la spécification utilisée
infoTitre, version, description de l’API
serversURL de base (production, staging…)
pathsChaque URI, avec les verbes qu’elle accepte
parametersParamètres (path, query, header) d’un endpoint
requestBodyCorps attendu (souvent pour POST/PUT/PATCH)
responsesRéponses possibles, par code de statut
components.schemasStructures de données réutilisables via $ref
components.securitySchemesMécanismes d’authentification (bearer, OAuth2…)
$refRéférence à un schéma défini dans components

Authentification en un coup d’œil

MécanismeCas d’usage typique
Clé d’APIAccès machine à machine
JWTUtilisateurs authentifiés, API stateless
OAuth2Déléguer un accès limité à une application tierce

Voir aussi la carte du cours pour naviguer entre les leçons.