Über OpenAPI und warum Sie es verwenden sollten
OpenAPI legt eine Standard- und programmiersprachenunabhängige Schnittstellenbeschreibung für Web-APIs fest. Es ermöglicht sowohl Menschen als auch Computern, die Funktionen eines Dienstes zu entdecken und zu verstehen, ohne auf Quellcode, andere Dokumentation oder den Netzwerkverkehr zugreifen zu müssen.
Mit einem OpenAPI-Dokument, das eine Web-API beschreibt, kann der Verbraucher die Web-API mit minimalem Aufwand verstehen und mit ihr kommunizieren.
Ein benutzerdefinierter Konnektor kann für jede Web-API erstellt werden, sofern dies in einem OpenAPI-Dokument ordnungsgemäß beschrieben wird. Das bedeutet, dass das VanArsdel-Fusionsentwicklungsteam nicht darauf beschränkt ist, benutzerdefinierte Konnektoren für ihre Power Apps-Anwendungen von Web-APIs zu erstellen, die in Azure API Management gehostet werden.
Was macht das OpenAPI-Dokument?
Das OpenAPI-Dokument legt gibt Vertrag auf der Oberfläche der Web-API an. Es abstrahiert die tatsächlichen Implementierungsspezifikationen vom Verbraucher der API. Das bedeutet, dass Sie Ihre Anwendung schnell erstellen können, indem Sie wissen, welche Methoden aufgerufen werden müssen und welche zurückgegeben werden, ohne Gedanken daran verschwenden zu müssen, wie diese Methoden aufgerufen werden.
In der vorherigen Lerneinheit haben Sie Azure API Management verwendet, um einen benutzerdefinierten Konnektor zu erstellen. Auf diese Weise haben Sie auch eine Abhängigkeit von Azure API Management erstellt. Mit anderen Worten, wenn Änderungen in Azure API Management auftreten, muss Ihr benutzerdefinierter Konnektor aktualisiert werden, um die Änderung widerzuspiegeln.
Mit dem OpenAPI-Dokument müssen Sie nicht wissen, wo die API ist oder ob sie ausgeführt wird, da das Dokument alle erforderlichen Informationen enthält.
Mit Power Apps können Sie mit diesem OpenAPI-Dokument sofort einen benutzerdefinierten Konnektor erstellen.
Sobald Sie den benutzerdefinierten Konnektor aus dem OpenAPI-Dokument erstellt haben, können Sie ihn auf Ihrer Power Apps-Seite anzeigen.
Warum ein OpenAPI-Dokument für benutzerdefinierte Konnektoren verwenden?
Die Verwendung des OpenAPI-Dokuments für die Erstellung Ihres benutzerdefinierten Konnektors bietet viele Vorteile. Die folgenden zwei Vorteile sind jedoch für Citizen Developer am wichtigsten.
- Abhängigkeiten entfernen: Mit einem OpenAPI-Dokument können Sie selbst einen benutzerdefinierten Konnektor erstellen, ohne darauf warten zu müssen, dass jemand über API Management einen für Sie erstellt. Zusätzlich werden bei professionellen Entwicklungsteams immer öfter Funktionen zur Generierung von OpenAPI-Dokumenten in die Web-API selbst aufgenommen. Das bedeutet, dass Sie das OpenAPI-Dokument herunterladen können, indem Sie eine URL aufrufen und dann den benutzerdefinierten Konnektor damit erstellen.
- Agilität steigern: Der Rhythmus Ihrer Power App-Entwicklung erhöht sich, wenn Ihr Web-API-Entwicklungsteam Ihnen ein OpenAPI-Dokument geben kann. Sie müssen sich nicht auf diese verlassen, für alles weitere zum Erstellen und Verwenden eines benutzerdefinierten Konnektors.
Wie Sie im folgenden Diagramm sehen können, muss das OpenAPI-Dokument die tatsächliche Implementierung der Web-API nicht kennen, solange der Vertrag unverändert bleibt.
Ein benutzerdefinierter Konnektor aus einem OpenAPI-Dokument oder aus Azure API Management
Zum Erstellen eines benutzerdefinierten Konnektors können Sie entweder Azure API Management oder ein OpenAPI-Dokument verwenden. Was davon sollten Sie auswählen?
In dieser Tabelle sind einige Vergleiche zwischen Azure API Management und OpenAPI für benutzerdefinierte Konnektoren aufgeführt.
| Konnektor | Azure API Management | OpenAPI-Dokument |
|---|---|---|
| API-Steuerelement | Zentralisiert | Verteilt |
| API-Strukturschicht | Komplex | Einfach |
| Zusätzliche Sicherheitsebene | Ja | Nein |
| Usage-Steuerelement | Ja | Nein |
| Zusätzliche Kosten | Ja | Nein |
| Architektonische Komplexität | Höher | Niedriger |