Anwendungsfälle von REST-APIs

Name: Anwendungsfälle von REST-APIs
Author: Josh Guardino

Sielernen, wie Sie die OpenAPI-Dokumentation nutzen und allgemeine Operationen durchführen können.

Preview the first lesson free — get full access to all 4 lessons.

Kurs: On-Demand

In dieser Lektion zeige ich Ihnen, wie man liest und verwenden Sie die OpenAPI-Dokumentation. Es gibt viele Arten von Dokumentationssystemen für REST-APIs aber das bekannteste und am weitesten verbreitete wird als OpenAPI-Spezifikation bezeichnet. OpenAPI wurde erstmals von Swagger eingeführt, Dabei handelt es sich um ein API-Toolset. Der Standard wird nun beibehalten von einer Gruppe namens OpenAPI Initiative, Das ist ein Konsortium von Experten im Bereich API-Technologie. Die OpenAPI-Initiative veröffentlicht eine Spezifikation Das bestimmt, wie die OpenAPI-Dokumentation erfolgt sollte aussehen und funktionieren. Werfen wir einen Blick auf eine Referenzimplementierung von OpenAPI. welches von Swagger gehostet wird. Es heißt Swagger Petstore, und es ist ein Beispielszenario mit Haustieren, Geschäfte und Benutzer. Dieses Dokumentationsformat soll sehr einfach sein zu lesen, umfassend und mit der Fähigkeit um jede API innerhalb der Dokumentation selbst zu testen. Die verschiedenen unterstützten HTTP-Methoden sind farblich gekennzeichnet. GET-Anfragen sind blau, POST-Anfragen sind grün, PUT-Anfragen sind orange, und DELETE-Anfragen sind rot. Obwohl diese Farben individuell angepasst werden können, Das sind die Standards. Durch Klicken auf jeden Endpunkt können Sie alle anzeigen der Details dieses bestimmten Endpunkts innerhalb der API. Beispielsweise Parameter, die an die API übergeben werden könnten: Musteranforderungsstellen, unterstützte Dokumentübertragungsarten, wie JSON oder XML, Beispielantworttexte für jeden Antwortcodetyp und Abfrageparameter, die an die API übergeben werden können. Außerdem steht am Ende eines OpenAPI-Spezifikationsdokuments: Sie können die Modelle finden. Diese würden die verschiedenen Arten von Objekten auflisten das könnte dabei sein innerhalb einer Antwort vom Server. Wenn man durchklickt, kann man die verschiedenen Attributnamen sehen und Datentypen. Probieren wir einen dieser Dienste aus. Wenn wir auf die GET-Anfrage klicken zum Auffinden von Haustieren anhand des Ausweises, Wir können sehen, dass es einen Parameter akzeptiert, die erforderlich ist und petId heißt. Es ist eine Ganzzahl, das heißt, es muss eine ganze Zahl sein. Klicken wir also auf die Schaltfläche "Ausprobieren". und geben Sie eine ID in das Feld ein. Klicken wir auf "Ausführen". Und es passieren ein paar Dinge. Zunächst wird die Curl-Anfrage angezeigt. Curl ist ein Befehlszeilenprogramm, das erstellt wird in die meisten Betriebssysteme integriert. Es ermöglicht Ihnen, Anfragen an jede Art von HTTP-Dienst zu senden durch Übergabe verschiedener Argumente an die ausführbare Curl-Datei. In diesem Fall also die angegebene OpenAPI-URL war /pet/ geschweifte Klammer, petId, schließende geschweifte Klammer. Variablennamen, die in geschweiften Klammern angezeigt werden, sind beabsichtigt durch tatsächliche Werte ersetzt werden. Und API-Endpunkte beginnen immer mit einem Schrägstrich. die an die Stamm-URL der API angehängt würde. Wie wir hier sehen können, die Root-URL ist https://petstore.swagger.io/v2. Die v2 steht hier für Version zwei und auf diese Weise wird die API-Versionierung normalerweise gehandhabt. Das -H steht für Header und in diesem Fall wir senden einen einfachen Accept-Header, Dadurch wird dem Server mitgeteilt, um welchen Typ es sich handelt welches Dokumentformat wir bevorzugen würden dass die Ergebnisse darin gespeichert werden. Als nächstes sehen wir die Antwort, die vom Server ausgegeben wurde. Der Statuscode ist hier 200, was bedeutet, dass die Anfrage erfolgreich war und was wir hier haben, ist ein Antwortgremium im JSON-Format und die verschiedenen Felder werden ausgefüllt mit den Werten, die vom Server abgerufen wurden. Dieser wird dann den Staat repräsentieren dieses bestimmten Objekts zu diesem Zeitpunkt. Unter dem Antworttext befinden sich Antwortheader. Hierbei handelt es sich um Metainformationen über die Anfrage, die hilft, weitere Informationen bereitzustellen über die Anfrage selbst. Versuchen wir nun, diese API mit einer ungültigen Haustier-ID zu testen. Die OpenAPI-Dokumentation kann dies bestätigen und nicht einmal zulassen, dass die Anfrage durchgeht. Anstatt also einen nicht numerischen Wert einzugeben, Geben wir eine Zahl ein, die numerisch ist wird aber nicht auf dem Server gefunden. Diesmal lautet unsere Antwort nicht 200, sondern 404. 404 ist der ausgegebene HTTP-Statuscode wenn eine Ressource nicht gefunden wird. Die verschiedenen anderen farbcodierten HTTP-Methoden und Endpunkte können zur Weitergabe von Informationen verwendet werden an den Server, um den Zustand eines Objekts zu ändern. Generieren einer OpenAPI-Dokumentation ist eine ziemlich einfache Operation, die durchgeführt werden kann aus einer Vielzahl von Tools und Programmiersprachen. Die OpenAPI-Dokumentation wird normalerweise nicht manuell erstellt von Hand, wird aber automatisch generiert über die erbrachten Leistungen. Dieses JSON-Dokument beschreibt beispielsweise die API und wäre Teil des Quellcodes der API. Wenn die API generiert wird, Die Spezifikationsdokumente werden automatisch erstellt über den Inhalt dieser Datei, Erstellung einer umfassenden Dokumentation einer beliebigen API eine einfache Operation das bleibt automatisch aktuell mit Änderungen an der API selbst. Danke fürs zuschauen. Seien Sie gespannt auf die nächste Lektion, die ich Ihnen zeigen werde wie man GET-Anfragen ausgibt, um den Status zu lesen von Objekten aus REST-APIs.

Anfänger Anbieter : Josh Guardino 4 Lektionen · 24m auf Arabisch, Deutsch, Englisch, Spanisch, Französisch, Portugiesisch, Chinese

Kursbeschreibung

REST ist ein API-Architekturstil, der sich stark auf Industriestandards sowie auf die grundlegenden Konzepte des Internets stützt. Dieser Ansatz ermöglicht gängige, wiederholbare Nutzungsmuster und passt zu weithin akzeptierten Standards für den API-Zugang und die Dokumentation. Es gibt viele vorgefertigte Module und Vorlagen für REST-APIs, aber es ist auch möglich - und sogar üblich - REST-APIs von Grund auf neu zu erstellen.

Es gibt viele API-Dokumentationsformate, aber das gängigste und vielleicht am einfachsten zu verwendende heißt OpenAPI. Es ermöglicht den Eigentümern von REST-APIs, interaktive Dokumentation zu veröffentlichen, die automatisch auf der Grundlage der Fähigkeiten der API generiert wird. Sie werden lernen, wie Sie die OpenAPI-Dokumentation lesen und API-Tests direkt aus ihr heraus durchführen können.

Es werden die gängigsten Arten von API-Aktionen und HTTP-Methoden behandelt, darunter Lesevorgänge mit der GET-Methode, Sendevorgänge mit der POST-Methode und Aktualisierungsvorgänge mit den Methoden PUT, PATCH und DELETE.

Was Sie lernen werden

Beschreiben Sie den Zweck und das Format der OpenAPI-Dokumentation, einschließlich wie man sie liest und API-Tests direkt aus ihr ausführt
ListenSie und beschreiben Sie die am häufigsten verwendeten HTTP-Methoden mit REST-APIs auf
Führen Sie Lesevorgänge durch, indem Sie verstehen, wie GET-Anfragen Daten von REST-APIs empfangen
Senden und aktualisieren Sie Daten, indem Sie identifizieren, wie Schreibvorgänge Request-Bodies an REST-APIs übergeben
Verwenden Sie POST-Anfragen, um Operationen an REST-APIs zu senden
Aktualisieren Sie den Objektzustand mit den Methoden PUT, PATCH und DELETE

Wichtige Erkenntnisse

REST ist ein API-Architekturstil, der auf Industriestandards und den Kernkonzepten basiert, die das Internet antreiben, und ermöglicht häufige, wiederholbare Verwendungsmuster.
REST-APIs können mit vorkonfigurierten Modulen und Vorlagen erstellt werden, aber es ist auch üblich, sie von Grund auf zu erstellen.
OpenAPI ist das gängigste und wohl einfachste API-Dokumentationsformat und ermöglicht es REST-API-Besitzern, interaktive, automatisch generierte Dokumentation basierend auf den API-Funktionen zu veröffentlichen.
GET wird für Lesevorgänge verwendet, POST für Sendvorgänge und PUT, PATCH und DELETE für Aktualisierungsvorgänge.
Schreibvorgänge senden Request-Bodies an REST-APIs, während GET-Anfragen Daten von ihnen empfangen.

Häufig gestellte Fragen

Was behandelt dieser Kurs?

Er behandelt den REST-API-Architekturstil, wie man OpenAPI-Dokumentation liest und API-Tests aus ihr ausführt, sowie die häufigsten API-Aktionen und HTTP-Methoden, einschließlich GET für Lesevorgänge, POST für Sendvorgänge und PUT, PATCH und DELETE für Aktualisierungsvorgänge.

Welche HTTP-Methoden werde ich kennenlernen?

Der Kurs behandelt die häufigsten HTTP-Methoden, einschließlich der GET-Methode zum Lesen von Daten, der POST-Methode zum Senden von Daten und der Methoden PUT, PATCH und DELETE zum Aktualisieren des Objektzustands.

Was ist OpenAPI und wie wird es in diesem Kurs verwendet?

OpenAPI ist das gängigste API-Dokumentationsformat, das es REST-API-Besitzern ermöglicht, interaktive Dokumentation zu veröffentlichen, die automatisch basierend auf den API-Funktionen generiert wird. In diesem Kurs lernen Sie, wie Sie OpenAPI-Dokumentation lesen und API-Tests direkt aus ihr ausführen.

Welche Lektionen sind in diesem Kurs enthalten?

Der Kurs umfasst vier Lektionen: OpenAPI-Dokumentation, GET-Anfragen, POST-Anfragen und Aktualisierung des Objektzustands mit HTTP-Methoden.

Welche Fähigkeiten hilft dieser Kurs zu entwickeln?

Er unterstützt Fähigkeiten wie API-Design, API-Management, REST-API-Entwicklung, RESTful-API, Rest-Client und Advanced Rest Client.