API-Response-Namenskonventionen: Umfassender Leitfaden
4 Min. Lesezeit
Konsistente Feldbenennung in API-Responses reduziert Verwirrung und macht Ihre API für Nutzer intuitiv.
Häufige Muster
| Feldtyp | Muster | Beispiele |
|---|---|---|
| ID | Ressource + Id/id | userId, orderId |
| Zeitstempel | Verb + At/at | createdAt, updatedAt |
| Boolean | is/has + Adjektiv | isActive, hasVerified |
| Anzahl | Substantiv + Count | itemCount, pageCount |
| URL | Substantiv + Url | avatarUrl, websiteUrl |
Paginierung
{ "data": [...], "pagination": { "page": 1, "pageSize": 20, "totalCount": 100, "totalPages": 5 } }
Umwandeln
Verwenden Sie den camelCase- oder snake_case-JSON-Key-Konverter.