Conventions de nommage des réponses API : Guide complet

4 min de lecture

Un nommage cohérent des champs dans les réponses API réduit la confusion et rend votre API intuitive pour les consommateurs.

Patterns courants

Type de champPatternExemples
IDressource + Id/iduserId, orderId
Timestampverbe + At/atcreatedAt, updatedAt
Booleanis/has + adjectifisActive, hasVerified
Compteurnom + CountitemCount, pageCount
URLnom + UrlavatarUrl, websiteUrl

Pagination

{ "data": [...], "pagination": { "page": 1, "pageSize": 20, "totalCount": 100, "totalPages": 5 } }

Convertir

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