Convenções de nomes em respostas API: Guia completo
4 min de leitura
Nomenclatura consistente em respostas API reduz confusão e torna sua API intuitiva para os consumidores.
Padrões comuns
| Tipo de campo | Padrão | Exemplos |
|---|---|---|
| ID | recurso + Id/id | userId, orderId |
| Timestamp | verbo + At/at | createdAt, updatedAt |
| Boolean | is/has + adjetivo | isActive, hasVerified |
| Contagem | substantivo + Count | itemCount, pageCount |
| URL | substantivo + Url | avatarUrl, websiteUrl |
Paginação
{ "data": [...], "pagination": { "page": 1, "pageSize": 20, "totalCount": 100, "totalPages": 5 } }Converter
Use o conversor de chaves JSON para camelCase ou snake_case.