Implementing REST API CRUD operations

Am Ende dieser Vorlesung sollten Sie in der Lage sein zu erklären, wie Urlaubsanfragen und -antworten für die aktuellen API-Vorgänge eingerichtet werden. Sie sollten auch in der Lage sein, den HTP-Statuscode zu beschreiben und von der API-Implementierung für die Kartenoperationen zurückzukehren. Ich erinnere daran, dass ich in allen vorherigen Vorlesungen über die Verwendung geeigneter EDV-Arbeiten für den laufenden Betrieb gesprochen habe. Sie würden also Post zum Löschen, Abrufen, Aktualisieren und Löschen zum Löschen verwenden. Zusätzlich zu diesen HTP-Arbeitsmethoden gibt es einige andere SCDP-Methoden, die Sie kennen sollten. Diese SCDP-Methoden werden bei den übrigen API-Implementierungen nicht sehr häufig verwendet. Der Beobachter erhält eine Anforderung vom Client oder der EDV-Postmethode zum Erstellen einer Ressource. Lassen Sie uns durchgehen, was in dieser Anfrage vom Client benötigt wird. Der Observer muss den Quellendpunkt angeben. Wenn es sich bei der Ressource beispielsweise um das Urlaubspaket im Fall von Acme handelt, haben Sie Recht. Wenn es sich bei der Ressource um eine Unterressource handelt, z. B. die Überprüfung, sieht der Euro folgendermaßen aus. Wenn Sie die Ferien mit einer bestimmten ID und dann die Ressourcenüberprüfung haben, werden die Daten für die Ressource im Hauptteil der Post-Anfrage übergeben. Für das Design der API muss der API-Client möglicherweise auch Header in der HTP-Post-Anforderung einrichten. Das ist aber nicht so üblich. Sie müssen in der HDP-Post-Anfrage festlegen, möglicherweise Standard-Header oder einige benutzerdefinierte Header. Lassen Sie uns als nächstes über die Antwort sprechen, die tatsächlich veröffentlicht werden soll. Der Initiativserver muss immer das Steuerkennzeichen im HDB-Header zurücksenden. Wenn die Erstellung der Ressource erfolgreich ist, sollte sie an Null gesendet werden. Wenn der Server feststellt, dass die Daten gesendet wurden, die Anforderung für die Ressource unvollständig oder aus irgendeinem Grund ungültig ist, sollte er vierhundert fehlende erforderliche Felder oder fehlerhafte Anforderungen zurücksenden. Wenn der Server ein Problem oder ein Problem bei der Verarbeitung der Anforderung hat, sollte er eine Nachricht mit fünfhundert Serien zurücksenden. Wenn die Datenbank beispielsweise nicht erreichbar ist, sollte sie fünf Null-Drei-Datenbanken zurücksenden, die für das Message Board nicht erreichbar sind. Die API-Implementierung kann zwei weitere Dinge tun. Möglicherweise wird die neue Ressourceninstanz zurückgegeben. Wenn sich die Daten beispielsweise in Jason Formate befinden, enthält der Body die Ressourcendarstellung in Jason Formic, oder die API-Implementierung kann einfach einen Link zur neu erstellten Ressourceninstanz zurückgeben. Wenn beispielsweise die neue Ressourceninstanz mit der Idee eins vier zwei drei erstellt wird, ist dies der Link, den der Server zurückgibt, und der Body zum Abrufen von Ressourcen. Der API-Client ruft den vom Server bereitgestellten Endpunkt auf, auf dem die Methode get ausgeführt wird. Die Anforderung wird für den Endpunkt für die Ressource ausgeführt. Dieser Endpunkt gibt eine Sammlung aller Ressourcen zurück. Wenn die ID im Pfad für den Euro angegeben ist, wird nur eine Instanz der Ressource zurückgegeben. In diesem Fall wird das Urlaubspaket mit der angegebenen ID zurückgegeben und angezeigt. Designer kann optional Abfrageparameter in der Anforderung der API zulassen. Der Implementierer kann vom API-Client verlangen, dass er Standard- oder benutzerdefinierte Header bereitstellt. In der Regel ist das Anforderungs-Boarding bei Abrufen optional. Bei der Antwortrückgabe von der Gate-Operation wird der HTP-Header auf 200 gesetzt. OK, wenn der Server in der Lage war, die angeforderten Ressourcen abzurufen, wenn der Client Informationen bereitgestellt hat, die vom Server nicht verarbeitet werden konnten, wird vom Client eine entsprechende Anforderung für 100 empfangen, z. B. für oder für den Fall, dass die Ressource vorhanden ist wurde nicht gefunden. Wenn der Server ein Problem mit der Verarbeitung der Anforderung hatte, sendet er einen fünfhundert Serienfehler im Hauptteil zurück. Es kann eine Sammlung von Ressourcen geben oder es kann eine einzelne Instanz der spezifischen Ressource geben, die vom Client zum Aktualisieren der Ressource angefordert wird. Sie können Port und Batch verwenden. Sie würden port verwenden, wenn alle Attribute der Ressource aktualisiert werden. Und Patch wird, wie der Name schon sagt, verwendet, wenn einige der Attribute der Ressource für große Objekte aktualisiert werden müssen. Es kann leistungsfähiger sein, sowohl Port als auch Port zu unterstützen. Die Idee ist, dass Sie nicht möchten, dass große Objektdaten jedes Mal für Objekte von zentraler Bedeutung sind, sondern dass Sie nur einen Teil der Daten senden können, die aktualisiert werden müssen. Hier ist ein Beispiel für ein Patch-Objekt, bei dem das Urlaubspaket mit Idy 121 aktualisiert wird, wobei nur das Wertattribut aktualisiert wird. Für die Anforderung des aktuellen Patches muss der Endpunkt mit der Identität der zu aktualisierenden Ressource als Teil der Anforderung bereitgestellt werden. Sie sind ein Parameter oder er kann im Körper für eine potente Charge bereitgestellt werden. Die API erfordert möglicherweise, dass der API-Client die Standard- oder benutzerdefinierten Header festlegt, die der Beobachter auf verschiedene Arten implementiert. Die Antwort zum Anlegen von Patch enthält den HTP-Header, in dem der Stardust-Code auf 200 gesetzt ist, wenn sich die aktualisierte Ressource im Hauptteil befindet. Es hat einen Anfang, eine Punktzahl von zwei Null Eins erstellt, aber die Körperdaten sind optional und es kann für keinen Inhalt auf Null zurückgesendet werden, wenn es keinen Inhalt im Körper gibt. Wenn dann Probleme auftreten, wird ein Fehler der 400er-Serie oder ein Fehler der 500er-Serie zurückgesendet. Der Text in der Antwort hängt vom SDP-Statuscode ab, der vom API-Server zum Löschen der Ergebnisse empfangen wurde. Das Löschen wird verwendet und die Anforderung wird an einen Endpunkt gesendet, der entweder eine Sammlung von Ressourcen oder eine bestimmte Ressource ist. Parameter können als Auswahlkriterien für die zu löschenden Ressourcen angegeben werden, und der Körper wird nicht benötigt, und die HTP-Helden hängen von den Anforderungen ab. Die API liefert daher eine Antwort auf das Löschen über den Erfolg des HTP-Codes 200. Wenn das Löschen der Ressource erfolgreich war und der Body die Daten für die gelöschte Ressource enthält, werden zweihundert und ohne Inhalt zurückgesendet, wenn der Body keinen Inhalt enthält und das Löschen erfolgreich war. Wenn ein Fehler auftritt, wird ein geeigneter Statuscode der 400er- oder 500er-Serie an den Körper zurückgesendet, und die Antwort hängt von der Status-Quo-Rückgabe ab. Aber es scheint, dass eine häufig gestellte Frage, die mir häufig gestellt wird, lautet: Kann ich Post zum Aktualisieren verwenden? Und die Antwort lautet: Ja, das können Sie. Tatsächlich erhalten Twitter-Benutzer nur einen Beitrag für alle APIs. Was ich Ihnen vorgeschlagen habe, sind allgemein angewandte Praktiken. Dies sind einige Richtlinien. Sie können Ihre eigenen Praktiken entwickeln und über alle Ihre APIs hinweg standardisieren. Werfen wir einen Blick auf die API von Twitter. Ich bin auf dem Entwicklerportal von Twitter und hier können Sie die API-Referenz für die verschiedenen Apps überprüfen, die auf Twitter verfügbar sind. Ich schaue mir also die Einstellungen für das Verwalten von Konten und die Profil-API an und Sie werden feststellen, dass nur Beiträge verwendet werden. Twitter verwendet, setzt, patcht und löscht nicht für alle Aktionen, die es nach dem Posten verwendet. Dies ist beispielsweise eine teilweise Aktualisierung des Kontos, die nicht den gleichen Effekt hat, als ob sie einen Patch verwenden würden. Hier erstellen sie neue Ressourcen zum Löschen. Sie benutzen es zerstören. Mithilfe der Euro-Pfadelemente definieren sie die verschiedenen Operationen, die für die Ressource ausgeführt werden sollen, verwenden jedoch nur den Beitrag, anstatt die anderen Verben zu verwenden. Daher haben Twitter-Entwickler ihre eigene Methode zum Erstellen der APIs entwickelt. Solange sie für alle APIs denselben Standard und dieselbe Richtlinie befolgen, kann dies keinen Schaden anrichten. Als Übung schlage ich vor, dass Sie die API-Dokumentation für oboH durchgehen und versuchen, die Frage zu beantworten, wie SCDP-Header in ihren APIs verwendet werden oder werden. Lassen Sie uns mit dem Kernpunkt dieser Vorlesung fortfahren. Sie sollten für alle Ihre APIs die entsprechende SCDP-Methode verwenden. Sie können Post zum Erstellen, Aktualisieren und Löschen der Ressourcen verwenden. Wenn Sie dies jedoch tun, behalten Sie die Konsistenz aller Ihrer Apps in der Antwort bei. Senden Sie immer die entsprechenden HTP-Statuscodes zurück, wie ich in dieser Vorlesung besprochen habe.