In diesem Blogbeitrag werden wir alles besprechen, was Sie über API und PUT-Anfragen wissen müssen. Wir beginnen damit, zu erklären, was eine API ist, und tauchen dann ein, was eine PUT-Anfrage ist und wie sie sich von anderen HTTP-Methoden wie POST unterscheidet.
Wir geben Ihnen einige Best Practices und gängige Antwortformate für API und zeigen Ihnen, wie Sie eine PUT-Anfrage in Apidog erstellen.
Entdecken Sie Apidog, indem Sie es kostenlos herunterladen und jetzt mit dem Testen beginnen!
Also, ohne Umschweife, lasst uns in die Welt der API und PUT-Anfragen eintauchen!
Was ist eine API?
Eine API, oder Application Programming Interface, ist eine Reihe definierter Regeln, die es verschiedenen Anwendungen ermöglichen, miteinander zu kommunizieren. Es ist wie ein Kellner, der Ihre Bestellung entgegennimmt und sie an die Küche weiterleitet und Ihnen dann Ihr Essen zurückbringt. APIs helfen verschiedenen Softwarekomponenten, einfach und sicher zu kommunizieren und Daten zu übertragen. Sie sind wie die geheime Zutat, die die Softwareentwicklung und -innovation einfacher und effizienter macht.
Wenn Sie beispielsweise eine mobile App verwenden, um eine Fahrt zu buchen, verwendet die App eine API, um mit den Servern des Fahrdienstes zu kommunizieren, um den Standort des Fahrers, die voraussichtliche Ankunftszeit und andere Details abzurufen. Dies hilft der App, Ihnen die Informationen in Echtzeit anzuzeigen.
Kurz gesagt, APIs sind wie der Klebstoff, der verschiedene Softwarekomponenten zusammenhält und es ihnen ermöglicht, nahtlos und effizient zu arbeiten.
Was ist eine PUT-Anfrage?
Eine PUT-Anfrage ist eine HTTP-Anfragemethode, die verwendet wird, um eine vorhandene Ressource auf dem Server zu aktualisieren oder zu ersetzen. Eine PUT-Anfrage erstellt eine neue Ressource oder ersetzt eine Darstellung der Zielressource durch die Anforderungsnutzlast.
Die Anfrage hat einen Body und die erfolgreiche Antwort hat einen Body. Die PUT-Anfrage ist nicht sicher und ist idempotent. Sie ist in HTML-Formularen nicht erlaubt. Hier ist ein Beispiel für eine PUT-Anfrage:
PUT /new.html HTTP/1.1
Host: example.com
Content-type: text/html
Content-length: 16
<p>New File</p>
Wenn die Zielressource keine aktuelle Darstellung hat und die PUT-Anfrage erfolgreich eine erstellt, muss der Ursprungsserver den User-Agent durch Senden einer 201 (Created)-Antwort informieren. Wenn die Zielressource eine aktuelle Darstellung hat und diese Darstellung erfolgreich in Übereinstimmung mit dem Zustand der eingeschlossenen Darstellung geändert wird, muss der Ursprungsserver entweder eine 200 (OK)- oder eine 204 (No Content)-Antwort senden, um den erfolgreichen Abschluss der Anfrage anzuzeigen.
Wie funktioniert eine PUT-Anfrage?
Wenn Sie eine HTTP-PUT-Anfrage stellen und der Request-URI auf eine vorhandene Ressource verweist, ersetzt der Server diese Ressource vollständig durch die Daten, die im Body der PUT-Anfrage enthalten sind. Wenn die Request-URI nicht auf eine vorhandene Ressource verweist, kann der Server die Ressource mit dieser URL erstellen.
PUT vs POST Requests
Der Unterschied zwischen einer PUT-Anfrage und einer POST-Anfrage besteht darin, dass eine PUT-Anfrage idempotent ist, was bedeutet, dass sie einmal oder mehrmals hintereinander aufzurufen, denselben Effekt hat (d. h. keine Nebenwirkung), während aufeinanderfolgende identische POST-Anfragen zusätzliche Effekte haben können, ähnlich dem mehrfachen Aufgeben einer Bestellung. PUT-Anfragen werden verwendet, um eine vorhandene Ressource auf dem Server zu aktualisieren oder zu ersetzen, während POST-Anfragen verwendet werden, um eine Ressource auf dem Server hinzuzufügen.
Wie man eine PUT-Anfrage in API sendet
Um eine PUT-Anfrage in einer API zu senden, müssen Sie die HTTP-Methode als PUT und die URL der Ressource angeben, die Sie aktualisieren oder ersetzen möchten. Sie müssen auch die aktualisierte Darstellung der Ressource in der Anforderungsnutzlast angeben. Hier ist ein Beispiel für eine PUT-Anfrage in Python mit der requests-Bibliothek:
import requests
url = 'https://example.com/api/resource/1'
data = {'key': 'value'}
response = requests.put(url, json=data)
In diesem Beispiel sendet die Methode requests.put() eine PUT-Anfrage an die angegebene URL mit der aktualisierten Darstellung der Ressource im Parameter data. Die Antwort vom Server wird in der Variable response gespeichert.
Erstellen und Testen einer PUT-Anfrage in Apidog
Apidog ist eine integrierte Kollaborationsplattform für API-Dokumentation, API-Debugging, API-Mocking und API-Automatisierungstests, die Postman, Swagger, Mock und JMeter kombiniert, um das Daten-Synchronisationsproblem zwischen verschiedenen Systemen mit einer Reihe von Systemen und einer Reihe von Daten zu lösen.
Es ist eine All-in-One-API-Kollaborationsplattform, die API-Dokumentation, API-Debugging, API-Mocking und API-Automatisierungstests bietet. Mit einem einzigen System und zentralisierten Daten löst Apidog das Problem der Datensynchronisation über mehrere Systeme hinweg. Sobald das API-Dokument definiert ist, können API-Debugging, Daten-Mocking und API-Tests direkt genutzt werden, ohne dass eine Neudefinition erforderlich ist.
Um eine PUT-Anfrage in Apidog zu erstellen und zu testen, können Sie diese Schritte ausführen:
- Öffnen Sie Apidog: Öffnen Sie Apidog und erstellen Sie eine neue Anfrage.
2. Geben Sie die HTTP-Methode an: Wählen Sie PUT als HTTP-Methode aus.
3. Definieren Sie die Anforderungs-URL: Geben Sie die URL der Ressource ein, die Sie aktualisieren möchten, fügen Sie Anforderungsheader und/oder den Anforderungstext hinzu. Klicken Sie dann auf die Schaltfläche "Senden", um die PUT-Anfrage zu senden
4. Überprüfen Sie die Antwort: Überprüfen Sie die Antwort vom Server, um sicherzustellen, dass die PUT-Anfrage erfolgreich war.
Best Practices für die Verwendung von PUT-Anfragen in API
Hier sind einige Best Practices für die Verwendung von PUT-Anfragen in einer API:
- Verwenden Sie ein konsistentes Antwortformat: Es ist eine gute Idee, ein konsistentes Antwortformat für alle Ihre Endpunkte zu verwenden, einschließlich PUT-Anfragen. Dies kann es für Clients einfacher machen, Ihre API zu verstehen und mit ihr zu arbeiten.
- Stellen Sie sicher, dass Aktualisierungen idempotent sind: Idempotente Operationen sind solche, die wiederholt ausgeführt werden können, ohne unbeabsichtigte Auswirkungen zu verursachen. PUT-Anfragen sind idempotent, was bedeutet, dass sie einmal oder mehrmals hintereinander aufzurufen, denselben Effekt hat. Dies liegt daran, dass die Anforderungsnutzlast die aktualisierte Darstellung der Ressource enthält. Wenn die Ressource nicht existiert, wird eine neue Ressource mit der angegebenen Darstellung erstellt.
- Organisieren Sie das API-Design um Ressourcen: REST-APIs sind um Ressourcen herum konzipiert, bei denen es sich um jede Art von Objekt, Daten oder Dienst handelt, auf die der Client zugreifen kann. Eine Ressource hat eine Kennung, die eine URI ist, die diese Ressource eindeutig identifiziert. Beispielsweise könnte die URI für eine bestimmte Kundenbestellung lauten:
https://example.com/orders/1. - Definieren Sie API-Operationen in Bezug auf HTTP-Methoden: REST-APIs verwenden Standard-HTTP-Methoden, um Operationen für Ressourcen auszuführen. Die gebräuchlichsten Operationen sind GET, POST, PUT, PATCH und DELETE. PUT-Anfragen werden verwendet, um eine vorhandene Ressource auf dem Server zu aktualisieren oder zu ersetzen, während POST-Anfragen verwendet werden, um eine Ressource auf dem Server hinzuzufügen.
- Konformität mit der HTTP-Semantik: REST-APIs sollten der HTTP-Semantik entsprechen. Beispielsweise sollten PUT-Anfragen verwendet werden, um eine vorhandene Ressource zu aktualisieren oder zu ersetzen, während POST-Anfragen verwendet werden sollten, um eine Ressource auf dem Server hinzuzufügen. Dies trägt dazu bei, dass Ihre API konsistent und einfach zu bedienen ist.
Einige gängige Antwortformate von PUT Request
Das Antwortformat für eine PUT-Anfrage hängt vom API-Design und dem spezifischen Anwendungsfall ab. Es ist jedoch eine gute Praxis, ein konsistentes Antwortformat für alle Ihre Endpunkte zu verwenden, einschließlich PUT-Anfragen. Hier sind einige gängige Antwortformate für PUT-Anfragen:
- HTTP-Statuscode 200 OK: Dieser Statuscode wird für ein erfolgreiches PUT eines Updates für eine vorhandene Ressource zurückgegeben. Es wird kein Antworttext benötigt. Der HTTP-Statuscode 204 No Content ist noch angemessener.
- HTTP-Statuscode 201 Created: Dieser Statuscode wird für ein erfolgreiches PUT einer neuen Ressource zurückgegeben, wobei die spezifischste URI für die neue Ressource im Location-Header-Feld zurückgegeben wird und alle anderen relevanten URIs und Metadaten der Ressource im Antworttext widergespiegelt werden.
- HTTP-Statuscode 409 Conflict: Dieser Statuscode wird für ein PUT zurückgegeben, das aufgrund einer Modifikation durch Dritte nicht erfolgreich war, wobei eine Liste der Unterschiede zwischen dem versuchten Update und der aktuellen Ressource im Antworttext enthalten ist.
- HTTP-Statuscode 400 Bad Request: Dieser Statuscode wird für ein erfolgloses PUT zurückgegeben, wobei im Antworttext Text in natürlicher Sprache (z. B. Englisch) steht, der erklärt, warum das PUT fehlgeschlagen ist.
Fazit
In diesem Blogbeitrag haben wir über PUT gelernt, eine HTTP-Methode, die verwendet wird, um eine Ressource auf einem Server zu erstellen oder zu aktualisieren. Sie wird verwendet, um den vorhandenen Datensatz zu aktualisieren, und wenn der Datensatz nicht existiert, wird ein neuer erstellt. Der grundlegende Unterschied zwischen den POST- und PUT-Anfragen spiegelt sich in den unterschiedlichen Bedeutungen der Request-URI wider.
Beim Entwerfen einer API ist es wichtig, die richtige Methode zu verwenden, je nachdem, auf welches Objekt Sie sich in der Anfrage beziehen. Wenn Sie die von Ihnen erstellten URL-Objekte explizit benennen, verwenden Sie PUT.
Darüber hinaus haben wir gelernt, wie man APIs mit dem Apidog API Developing Toolkit erstellt und testet. Mit diesem Toolkit können Sie APIs schneller und gemeinsam entwerfen und entwickeln. 🚀
