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 champ | Pattern | Exemples |
|---|---|---|
| ID | ressource + Id/id | userId, orderId |
| Timestamp | verbe + At/at | createdAt, updatedAt |
| Boolean | is/has + adjectif | isActive, hasVerified |
| Compteur | nom + Count | itemCount, pageCount |
| URL | nom + Url | avatarUrl, 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.