Importieren und Veröffentlichen einer API
Sie müssen die API importieren und veröffentlichen, um sie über ein API-Gateway zur Verfügung zu stellen.
Im Beispiel des Schuhunternehmens möchte das Unternehmen NorthWind Shoes ausgewählten Partnern ermöglichen, den Lagerbestand abzufragen.
Hier erfahren Sie, wie Sie eine API in Azure API Management importieren und für Clients verfügbar machen.
API
Eine API ist eine standardisierte Möglichkeit für Unternehmen, spezifische Daten für Entwickler oder Partner verfügbar zu machen. In der vorherigen Übung haben Sie beispielsweise eine API erstellt, um Informationen zu Produkten und Lagerbeständen freizugeben.
Wenn Sie eine API zur Verfügung stellen möchten, müssen Sie diese zuerst in API Management importieren. Anschließend können Sie folgende Aktionen ausführen:
- Verwenden der Visualisierungstools am API-Gateway zum Testen der App
- Verwalten des API-Zugriffs mithilfe von Richtlinien
API-Frameworks
Es gibt verschiedene API-Frameworks und -Standards. API Management stellt mehrere Optionen für den Import von APIs bereit.
| Typ | Details |
|---|---|
| HTTP | Sie können eine HTTP-API mit einer leeren API-Definition importieren. Anschließend geben Sie manuell alle erforderlichen Parameter an. |
| WebSocket | Richten Sie den Passthrough zu einem Back-End-WebSocket-Dienst ein. |
| GraphQL | Richten Sie den Passthrough zu einem Back-End-GraphQL-Dienst ein, oder importieren Sie ein GraphQL-Schema, und erstellen Sie eine synthetische GraphQL-API mit benutzerdefinierten Feldlösern. |
| OpenAPI | OpenAPI ist eine Spezifikation, mit der alle Endpunkte und Vorgänge für RESTful-APIs sowie sämtliche Eingabe- und Ausgabeparameter dokumentiert werden. OpenAPI hieß ursprünglich Swagger. |
| WADL | Die Web Application Description Language ist eine XML-Beschreibung HTTP-basierter Webdienste. Sie stellt ein übersichtlicheres und kompakteres Format als WSDL dar. |
| WSDL | Die Web Service Description Language ist eine XML-Beschreibung beliebiger Netzwerkdienste und damit nicht auf HTTP beschränkt. |
Sie können APIs auch aus mehreren Back-End-Azure-Ressourcen importieren.
| type | Details |
|---|---|
| Logik-App | Logik-Apps werden verwendet, um Workflows und Integrationen verschiedener Datenquellen zu orchestrieren und zu automatisieren. |
| App Service | Dabei handelt es sich um eine API, die in einem App-Dienst in Azure gehostet ist. |
| Funktions-App | Diese Apps enthalten serverlosen Code, der durch Trigger aufgerufen werden kann. |
| Container-App | Serverlose Container für Microservices. |
Importieren einer API
Es gibt mehrere Möglichkeiten, eine API in Azure API Management zu importieren.
Wenn Sie das Azure-Portal verwenden, klicken Sie auf APIs und anschließend auf + API hinzufügen. Wählen Sie zuerst den API-Typ aus, den Sie importieren möchten.
Geben Sie anschließend einen Link zu Ihrer API-Spezifikation als URL oder Datei und einen Namen für die API an. Auf dem folgenden Screenshot sehen Sie ein Beispiel für den OpenAPI-Import.
Wenn Sie viele APIs importieren und konfigurieren, ist das Azure-Portal dafür nicht das effizienteste Tool. Beim Hochskalieren Ihrer API-Verwaltung benötigen Sie andere Tools (beispielsweise Azure CLI, Azure Resource Manager- bzw. Bicep-Vorlagen oder Azure PowerShell). Sie können z. B. Azure PowerShell-Cmdlets verwenden, um API-Gateways bereitzustellen, Produkte zu definieren und zu konfigurieren, APIs zu importieren und Benutzer*innen sowie Abonnements zu verwalten.
Visualisieren
Sie können das API-Gateway verwenden, um zu visualisieren, wie Daten von Ihren importierten APIs verarbeitet werden. Außerdem haben Sie die Möglichkeit, mit Datasets zu interagieren und Parameter mithilfe der API zu übergeben.
Wenn Sie Administrator*in sind, können Sie APIs im Azure-Portal anzeigen lassen.
Richtlinien
Mit Richtlinien erhalten Sie leistungsstarke Funktionen, mit denen Sie das Verhalten einer API über Konfigurationen ändern können. Sie stellen eine Sammlung von Anweisungen dar, die sequenziell bei Anforderungen oder Antworten einer API ausgeführt werden.
Folgende häufig verwendete Konfigurationen werden unterstützt:
- Konvertieren von XML- in JSON-Dateien
- Begrenzen eingehender Aufrufe
- Festlegen von Headern für eingehende und ausgehende Verbindungen
Im Azure-Portal können Sie verschiedene Richtlinien auf APIs anwenden. Richtlinien können Sie sich auf der Registerkarte Entwurf ansehen.
Über die Registerkarte Entwurf können Sie außerdem neue Richtlinien hinzufügen.
Produkt
Ein Produkt ist eine Sammlung von APIs. Sie können mehr als einem Produkt APIs zuweisen. Möglich wäre etwa, dass das Produkt NorthWindShoesPartners zwei APIs für Ihre Partner verfügbar machen soll:
| Produkt | NorthWindShoesPartners |
|---|---|
| API 1 | Bestand |
| API 2 | Planung |
Für Ihre Lieferanten machen Sie im Beispiel nur eine API verfügbar:
| Produkt | NorthWindShoesSuppliers |
|---|---|
| API 1 | Bestand |
| API 2 |
Mit Richtlinien können Sie für Produkte unterschiedliche Zugriffsregeln, Verbrauchskontingente und Nutzungsbedingungen festlegen. Wenn also Ihre Partner und Lieferanten unterschiedliche Rechte für den Zugriff auf die API für den Bestand erhalten sollen, müssen Sie diese zwei unterschiedlichen Produkten zuweisen.
Im Azure-Portal können Sie APIs einem Produkt zuordnen.
Für alle Tarife mit Ausnahme des Verbrauchstarifs gibt es zwei Standardprodukte: Starter und Unbegrenzt. „Unbegrenzt“ eignet sich für die Verwaltung von Produktions-APIs, da die Zahl der angefügten APIs nicht beschränkt ist. Sie können beliebig viele neue Produkte nach Bedarf erstellen. Für „Starter“ ist die Zahl der API-Aufrufe pro Minute auf fünf und pro Woche auf 100 beschränkt.