URL Konventionen, Methoden, Fehler ('GET', 'POST', 'PUT', 'DELETE')

URL Konventionen, Methoden, Fehler ('GET', 'POST', 'PUT', 'DELETE')

Eine zuverlässige und verständliche API beginnt mit zählbaren Regeln für den Aufbau von Schnittstellen. Wir halten uns an die Best Practices von REST, damit jeder Entwickler weiß, was ihn erwartet: Die URL-Struktur ist logisch, die Methoden entsprechen der Aktion und Fehler sind leicht zu interpretieren.

Dies senkt die Einstiegsschwelle, vereinfacht die Integration und ermöglicht eine Systemskalierung ohne Chaos.

URL- und HTTP-Methodenkonventionen

Methode	Zweck	Beispiel für einen Antrag
„GET“	Beschaffung der Ressource	„GET/users/42“
„POST“	Schaffung einer neuen Ressource	„POST/Nutzer“
„PUT“	Vollständige Aktualisierung der Ressource	„PUT/Benutzer/42“
'PATCH'	Teilweise Aktualisierung der Ressource (opz.)	`PATCH /users/42`
„DELETE“	Streichung einer Ressource	„DELETE/users/42“

Verwendbar im Plural ('/users', '/devices', '/games')
Verschachtelte Entitäten werden als Hierarchie beschrieben ('/users/42/sessions')
Alle Anfragen laufen über HTTPS

Standards für die Fehlerbehandlung

Code	Bedeutung	Beispielmeldung
„400“	Ungültiger Antrag	„Erforderliches Feld fehlt: E-Mail“
„401“	Nicht autorisiert	„Invalid token or expired session“
„403“	Zugang verweigert	„Zugang zu Ressourcen verweigert“
„404“	Nicht gefunden	„Benutzer mit ID 42 nicht gefunden“
„409“	Konflikt (z. B. Vervielfältigung)	„E-Mail bereits im Einsatz“
"422"	Validierungsfehler	"Feldalter" muss eine Zahl sein "
„500“	Interner Serverfehler	„Unexpected exception, contact support“

Struktur der Fehlerantwort:

• ```json
• {
• “ error “ : {
• “ code “ : 400,
• “ message “ : “ Missing required field: email “ ,
• “ details “ : {...}
• }
• }
• ```

Vorteile für Entwickler

Schnelles Verständnis der API-Logik ohne unnötige Dokumentation
Einheitlicher Ansatz für alle Module und Entitäten
Einfaches Debuggen und Loggen dank Standardcodes und -formaten
Kompatibel mit OpenAPI/Swagger, Postman, Auto-Generierung SDK
Vereinfachte Unterstützung, Tests und CI/CD

Wo es besonders wichtig ist

Plattformen mit offener oder Partner-API
Projekte mit mehreren Entwicklungsteams
Microservices-Architektur oder API-erster Ansatz
Systeme mit einer großen Anzahl von Entitäten und Interaktionen

Einheitliche Konventionen machen APIs zuverlässig, verständlich und benutzerfreundlich. Wir halten uns an die besten REST-Praktiken, um sicherzustellen, dass jede Integration schnell, ohne Missverständnisse und mit maximaler Vorhersehbarkeit erfolgt.