Bonnes pratiques de formatage JSON : structure, nommage et style

Un JSON bien formaté est plus facile à lire, à déboguer et à maintenir. Ces bonnes pratiques s'appliquent aux réponses d'API, aux fichiers de configuration et au stockage de données.

Nommage

• Utilisez un style cohérent (camelCase ou snake_case)
• Soyez descriptif : createdAt plutôt que ca
• Utilisez le pluriel pour les tableaux : "items" plutôt que "item"
• Évitez les abréviations : organizationId plutôt que orgId
• Utilisez les préfixes is/has pour les booléens : "isActive", "hasPermission"

Structure

• Évitez l'imbrication au-delà de 3 niveaux
• Utilisez des tableaux pour les collections ordonnées, des objets pour les données clé-valeur
• Incluez null pour les champs optionnels manquants (ne les omettez pas)
• Utilisez ISO 8601 pour les dates : "2026-06-01T00:00:00Z"
• Utilisez des chaînes pour les énumérations : "status": "active" est plus clair que "status": 1

Style

• Pretty-print (2 espaces d'indentation) en développement pour faciliter le débogage
• Minifiez en production pour économiser la bande passante
• Évitez les virgules finales (invalides en JSON)
• Les commentaires ne sont pas supportés — utilisez des champs de métadonnées

Bon exemple vs. mauvais exemple

Mauvais	Bon	Pourquoi
{"ca": "2026-01-01"}	{"createdAt": "2026-01-01T00:00:00Z"}	Nom descriptif + ISO 8601
{"item": [...]}	{"items": [...]}	Pluriel pour les tableaux
{"status": 1}	{"status": "active"}	Les énumérations de chaînes sont plus claires
{"userId": 1, "user_name": "A"}	{"userId": 1, "userName": "A"}	Cohérence du style

Convertissez vos clés

Utilisez notre convertisseur de clés JSON en camelCase ou clés JSON en snake_case.