Wie wählt man beim Entwerfen einer REST-API zwischen den Methoden PUT, POST und PATCH?

Die Wahl zwischen PUT, POST und PATCH hängt von der Art der Operation mit der Ressource ab:

• POST — wird verwendet, um eine neue Ressource zu erstellen. Die Anfrage wird in der Regel an die Sammlung gesendet, und der Server erstellt ein neues Element.

• PUT — wird für die vollständige Aktualisierung der Ressource verwendet. Der Client sendet eine vollständige Darstellung der Ressource, und der Server ersetzt das bestehende Objekt durch diese neue Version.

• PATCH — für die teilweise Aktualisierung der Ressource. Der Client sendet nur die geänderten Felder, und der Server aktualisiert sie, ohne das gesamte Objekt zu ersetzen.

Beispiel:

• Benutzer erstellen — POST /users
• Das gesamte Benutzerprofil aktualisieren — PUT /users/{id}
• Nur die E-Mail des Benutzers ändern — PATCH /users/{id}