REST-API-Namenskonventionen: URLs, Methoden und JSON-Keys

Eine gut benannte REST-API ist intuitiv, konsistent und selbstdokumentierend. Diese Konventionen werden von den meisten Produktions-APIs befolgt.

URL-Pfad-Konventionen

• Verwenden Sie kebab-case oder Kleinbuchstaben für URL-Pfade: /user-profiles
• Verwenden Sie Substantive im Plural für Sammlungen: /users, /orders
• Verwenden Sie Ressourcen-IDs für einzelne Elemente: /users/123
• Verschachteln Sie Unterressourcen: /users/123/orders
• Vermeiden Sie Verben in URLs: POST /users statt POST /create-user

HTTP-Methoden

Methode	Zweck	Beispiel
GET	Lesen	GET /users/123
POST	Erstellen	POST /users
PUT	Vollständiges Update	PUT /users/123
PATCH	Teilweises Update	PATCH /users/123
DELETE	Löschen	DELETE /users/123

JSON-Response-Keys

Verwenden Sie camelCase (Google-Stil) oder snake_case (GitHub/Stripe-Stil). Wählen Sie eines und bleiben Sie über alle Endpunkte hinweg konsistent.

Query-Parameter

Verwenden Sie konsistent snake_case oder camelCase: ?page_size=20&sort_by=created_at

Formate konvertieren

kebab-case-Konverter für URLs, camelCase oder snake_case für JSON-Keys. Probieren Sie den Hub.