Gutes API-Design spart allen Zeit. Gehen Sie diese Checkliste vor der Veroeffentlichung Ihrer API durch.
Benennung & Struktur¶
- ☐ Ressourcen als Substantive (/users, /orders)
- ☐ Plural konsistent
- ☐ Hierarchische URLs (/users/123/orders)
- ☐ Kebab-Case fuer Multi-Word
- ☐ Versionierung (v1/users oder Accept-Header)
HTTP-Methoden¶
- ☐ GET = Lesen (idempotent)
- ☐ POST = Erstellung
- ☐ PUT = Vollstaendiges Update
- ☐ PATCH = Teilweises Update
- ☐ DELETE = Loeschung
Response¶
- ☐ Konsistentes Response-Format
- ☐ Korrekte Statuscodes
- ☐ Paginierung (Limit/Offset oder Cursor)
- ☐ Filter- und Sortierparameter
- ☐ HATEOAS-Links (optional)
Error Handling¶
- ☐ Strukturierte Fehlerantwort { code, message, details }
- ☐ Validierungsfehler mit feldspezifischen Details
- ☐ Keine Stack Traces in Produktion
- ☐ Rate-Limit-Header (X-RateLimit-*)
Sicherheit¶
- ☐ Authentifizierung (Bearer Token / API Key)
- ☐ Autorisierung an jedem Endpoint
- ☐ Eingabevalidierung und -bereinigung
- ☐ CORS korrekt konfiguriert
- ☐ Rate Limiting
Dokumentation¶
- ☐ OpenAPI/Swagger-Spezifikation
- ☐ Beispiele fuer jeden Endpoint
- ☐ Fehlerkatalog
- ☐ Getting-Started-Leitfaden
Tipp¶
Entwerfen Sie APIs aus der Perspektive des Konsumenten, nicht der Implementierung. Und schreiben Sie immer eine OpenAPI-Spezifikation.
apirestdesign