Wie man bessere REST-APIs entwirft

• Konsistenz wahren: URL/Header/Authentifizierung/Statuscodes ..
• Datumsformat nach ISO8601 UTC verwenden
• Nur Public Endpoints sind von der Authentifizierung ausgenommen. Für alle übrigen ist Authentifizierung erforderlich.
• Health-Check-Endpoint bereitstellen
• API-Versionierung
• API-Key-Authentifizierung anwenden
• Sinnvolle HTTP-Statuscodes und -Methoden verwenden
• Für jeden Endpoint einen einfachen Namen verwenden, der für sich selbst erklärend ist
• Standardisierte Fehlerantworten verwenden
• In POST die erstellte Ressource zurückgeben
• PATCH statt PUT
• So spezifisch wie möglich sein
• Paginierung verwenden
• Jede Ressource erweiterbar gestalten (zusätzliche Informationen per Query-Parametern wie expand zurückgeben können)

[eajrezz]

In letzter Zeit bin ich hier und da oft auf ähnliche Inhalte gestoßen, und ich empfehle "Web API Design: Die Kunst, APIs zu entwickeln, die Entwickler lieben". Wegen des Titels und des Covers könnte man es leicht für eine Art leicht verständliches Buch mit Alltagsvergleichen zum Internet halten, aber es ist ein sehr gutes Buch, in dem die Einsichten des Autors zur API-Gestaltung besonders hervorstechen, da API-Design sein Beruf ist.

[xguru]

Microsoft REST-API-Richtlinien
REST-API-Richtlinien von Stack Overflow