Conventions de nommage REST API : URLs, méthodes et clés JSON

Une REST API bien nommée est intuitive, cohérente et auto-documentée. La plupart des APIs de production suivent ces conventions.

Conventions de chemin URL

• Utilisez kebab-case ou des minuscules pour les chemins URL : /user-profiles
• Utilisez des noms au pluriel pour les collections : /users, /orders
• Utilisez des IDs de ressource pour les éléments individuels : /users/123
• Imbriquez les sous-ressources : /users/123/orders
• Évitez les verbes dans les URLs : POST /users et non POST /create-user

Méthodes HTTP

Méthode	Objectif	Exemple
GET	Lire	GET /users/123
POST	Créer	POST /users
PUT	Mise à jour complète	PUT /users/123
PATCH	Mise à jour partielle	PATCH /users/123
DELETE	Supprimer	DELETE /users/123

Clés de réponse JSON

Utilisez camelCase (style Google) ou snake_case (style GitHub/Stripe). Choisissez-en un et restez cohérent sur tous les endpoints.

Paramètres de requête

Utilisez snake_case ou camelCase de manière cohérente : ?page_size=20&sort_by=created_at

Convertir les formats

Convertisseur kebab-case pour les URLs, camelCase ou snake_case pour les clés JSON. Essayez le hub.