JSON-Formatierung: Best Practices für Struktur, Benennung und Stil

Gut formatiertes JSON ist leichter zu lesen, zu debuggen und zu warten. Diese Best Practices gelten für API-Antworten, Konfigurationsdateien und Datenspeicherung.

Benennung

• Verwenden Sie konsistente Schreibweise (camelCase oder snake_case)
• Seien Sie beschreibend: createdAt statt ca
• Verwenden Sie Pluralformen für Arrays: "items" statt "item"
• Vermeiden Sie Abkürzungen: organizationId statt orgId
• Verwenden Sie is/has-Präfixe für Booleans: "isActive", "hasPermission"

Struktur

• Vermeiden Sie Verschachtelungen tiefer als 3 Ebenen
• Verwenden Sie Arrays für geordnete Sammlungen, Objekte für Key-Value-Daten
• Fügen Sie null für fehlende optionale Felder ein (lassen Sie sie nicht weg)
• Verwenden Sie ISO 8601 für Datumsangaben: "2026-06-01T00:00:00Z"
• Verwenden Sie Strings für Enums: "status": "active" ist klarer als "status": 1

Stil

• Pretty-Print (2 Leerzeichen Einrückung) in der Entwicklung für leichteres Debugging
• Minifizieren in Produktions-APIs, um Bandbreite zu sparen
• Vermeiden Sie nachgestellte Kommas (in JSON ungültig)
• Kommentare werden nicht unterstützt — verwenden Sie Metadaten-Felder

Gutes vs. schlechtes Beispiel

Schlecht	Gut	Warum
{"ca": "2026-01-01"}	{"createdAt": "2026-01-01T00:00:00Z"}	Beschreibender Name + ISO 8601
{"item": [...]}	{"items": [...]}	Plural für Arrays
{"status": 1}	{"status": "active"}	String-Enums sind klarer
{"userId": 1, "user_name": "A"}	{"userId": 1, "userName": "A"}	Konsistente Schreibweise

Keys konvertieren

Verwenden Sie unseren JSON-Keys-zu-camelCase oder JSON-Keys-zu-snake_case Konverter.