Aller au contenu
Miraat·dweb developer journey, reflected

Concevoir une API REST

Conventions d'URL, méthodes HTTP, status codes, pagination, erreurs. L'API que les autres adorent utiliser.

Core 30 minutes Prérequis: Routing et MVC

Conventions

  • URLs = noms, pas de verbes : /api/skills, pas /api/getSkills.
  • Méthodes HTTP pour les actions : GET, POST, PATCH, DELETE.
  • Pluriel pour les collections, singulier pour les sous-ressources : /api/skills/42/resources.
  • Erreurs cohérentes : { "error": "validation", "fields": { … } }.
  • Paginer avec curseurs (?cursor=…&limit=20) ou offsets (?page=2).
  • Versionner dans l'URL ou l'en-tête : /v1/skills, Accept-Version: 1.

Exemple minimal

GET    /v1/skills?roadmap=frontend     → 200, liste
POST   /v1/skills                      → 201, créé
PATCH  /v1/skills/42                   → 200, mis à jour
DELETE /v1/skills/42                   → 204, no content

Ressources recommandées