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

FeldtypMusterBeispiele
IDRessource + Id/iduserId, orderId
ZeitstempelVerb + At/atcreatedAt, updatedAt
Booleanis/has + AdjektivisActive, hasVerified
AnzahlSubstantiv + CountitemCount, pageCount
URLSubstantiv + UrlavatarUrl, websiteUrl

Paginierung

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

Umwandeln

Verwenden Sie den camelCase- oder snake_case-JSON-Key-Konverter.