Migrieren vom API-Portal mit Azure Spring Apps Enterprise-Plan zu Azure API Management

Hinweis

Die Pläne Basic, Standard und Enterprise gelten ab Mitte März 2025 als veraltet und werden über einen Zeitraum von drei Jahren eingestellt. Es wird empfohlen, auf Azure Container Apps umzustellen. Weitere Informationen finden Sie in der Ankündigung zur Einstellung von Azure Spring Apps.

Der Plan Standardverbrauch und dediziert gilt ab dem 30. September 2024 als veraltet und wird nach sechs Monaten vollständig eingestellt. Es wird empfohlen, auf Azure Container Apps umzustellen. Weitere Informationen finden Sie unter Migrieren des Plans „Standardverbrauch und dediziert“ von Azure Spring Apps zu Azure Container Apps.

Dieser Artikel gilt für: ❎ Basic/Standard ✅ Enterprise

In diesem Artikel wird beschrieben, wie Sie vom API-Portal zu Azure API Management migrieren.

Azure API Management bietet eine zentrale Benutzeroberfläche zum Anzeigen von API-Definitionen und zum Testen bestimmter API-Routen direkt im Browser. Es unterstützt auch einmaliges Anmelden (Single Sign-On, SSO) für mehr Sicherheit und einen nahtlosen Zugriff. Durch die Migration vom API-Portal mit Azure Spring Apps zu Azure API Management können Sie die Skalierbarkeit, Sicherheit und Integration mit anderen Azure-Diensten verbessern.

Voraussetzungen

• Eine vorhandene Azure Spring Apps-Instanz mit Enterprise-Plan und aktiviertem API-Portal
• Eine vorhandene Azure-Container-App Weitere Informationen finden Sie unter Schnellstart: Bereitstellen Ihrer ersten Container-App über das Azure-Portal.

Erstellen einer API Management-Instanz

Führen Sie die folgenden Schritte aus, um eine API Management-Instanz zu erstellen:

1. Suchen Sie im Azure-Portal auf der Suchleiste nach API Management.

2. Wählen Sie in den Ergebnissen API Management-Dienste und dann Erstellen aus.

3. Geben Sie die folgenden erforderlichen Informationen an:

   • Abonnement: Wählen Sie das Azure-Abonnement für Ihren Dienst aus.
   • Ressourcengruppe: Wählen Sie eine vorhandene Ressourcengruppe oder Neu erstellen aus, um eine neue zu erstellen.
   • Region: Wählen Sie den Standort oder die Region für Ihre API Management-Instanz aus.
   • Ressourcenname: Geben Sie einen global eindeutigen Namen für die API Management-Instanz an.
   • Organisationsname: Geben Sie den Namen Ihrer Organisation an.
   • Administrator-E-Mail: Geben Sie eine E-Mail-Adresse an, die für Benachrichtigungen im Zusammenhang mit der API Management-Instanz verwendet werden soll.

4. Wählen Sie den Tarif basierend auf Ihrem Anwendungsfall aus. Sie können den Tarif später jederzeit upgraden oder ändern.

5. Konfigurieren Sie optionale Einstellungen wie Überwachung und VNet-Einstellungen.

6. Wählen Sie Überprüfen und erstellen aus, um die Einstellungen und die Konfiguration zu überprüfen.

7. Nachdem die Überprüfung abgeschlossen ist, wählen Sie Erstellen. Die Bereitstellung kann 30 bis 40 Minuten dauern.

8. Navigieren Sie nach Abschluss der Bereitstellung zur Seite API Management-Dienst, um den neu erstellten Dienst anzuzeigen.

Importieren verfügbarer APIs in API Management

Es gibt zwei Optionen zum Importieren von APIs in der API Management: manuelles Hinzufügen von APIs oder Importieren einer API-Spezifikationsdatei.

Manuelles Hinzufügen von APIs

Führen Sie die folgenden Schritte aus, um APIs manuell hinzuzufügen:

1. Navigieren Sie im Azure-Portal zur API Management-Instanz. Wählen Sie im Abschnitt APIs die Option API hinzufügen aus.

2. Wählen Sie im Bereich Neue API definieren die Option HTTP aus, um manuell eine HTTP-API zu definieren.

3. Geben Sie die folgenden API-Grundwerte an, und wählen Sie dann Erstellen aus, um sie zu speichern:

   • Anzeigename: Geben Sie einen Namen für Ihre API an.
   • Name: Geben Sie einen eindeutigen Bezeichner für die API an.
   • Webdienst-URL: Geben Sie die Basis-URL der Back-End-API Ihrer Container Apps-Instanz an.
   • API-URL-Suffix: Legen Sie das Suffix für diese API fest, z. B. /api/kundendienst.

4. Um neue API-Endpunkte zu erstellen, wählen Sie Vorgang hinzufügen aus und führen dann die folgenden Schritte aus:

   1. Geben Sie allgemeine Informationen an. Geben Sie Werte für Anzeigename und Name ein.
   2. Geben Sie die Details für den Vorgang an, z. B. das HTTP-Verb - GET, POST usw., URL, Abfrageparameter, Anforderung und Antwort.
   3. Speichern Sie Ihre API, nachdem Sie alle Vorgänge hinzugefügt haben.

5. Wählen Sie die Namen der hinzugefügten APIs aus. Auf der Registerkarte Entwurf werden alle hinzugefügten Vorgänge angezeigt.

Importieren einer API-Spezifikationsdatei

Wenn Sie über eine OpenAPI-Spezifikation (Swagger-Definition) Ihrer APIs verfügen, können Sie diese mithilfe der folgenden Schritte direkt in API Management importieren:

1. Navigieren Sie im Azure-Portal zur API Management-Instanz.

2. Öffnen Sie den Abschnitt APIs unter APIs.

3. Wählen Sie API hinzufügen aus.

4. Wählen Sie für Aus Definition erstellen die Option OpenAPI aus, mit der eine standardmäßige, sprachenunabhängige Schnittstelle mit den REST-APIs erstellt wird.

5. Führen Sie die folgenden Schritte aus, um eine API aus einer OpenAPI-Spezifikation zu erstellen:

   1. Wenn Sie über eine lokale API-Spezifikationsdatei verfügen, wählen Sie Datei auswählen aus, um die Datei hochzuladen. Geben Sie alternativ eine öffentlich zugängliche URL zur OpenAPI-Spezifikation an.
   2. Sie können die API-Einstellungen weiter verfeinern, indem Sie Werte für Anzeigename, Name und API-URL-Suffix der APIs angeben.
   3. Wählen Sie zum Speichern der Konfiguration Erstellen aus.

6. Wählen Sie die Namen der hinzugefügten APIs aus. Auf der Registerkarte Entwurf werden alle hinzugefügten Vorgänge angezeigt.

Testen von APIs in API Management

Azure API Management bietet eine integrierte Testkonsole im Azure-Portal, sodass Sie problemlos mit Ihren APIs interagieren können, ohne externe Tools zu benötigen. Gehen Sie folgendermaßen vor, um Ihre APIs zu testen:

1. Navigieren Sie im Azure-Portal zur API Management-Instanz.

2. Wählen Sie in der Liste im Abschnitt APIs die API aus, die Sie testen möchten.

3. Wählen Sie einen Vorgang aus. Auf der Übersichtsseite der API wird eine Liste der verfügbaren Vorgänge (Endpunkte) angezeigt. Wählen Sie den Vorgang aus, den Sie testen möchten.

4. Wählen Sie die Registerkarte Testen aus, um sie im Azure-Portal zu öffnen.

5. Konfigurieren Sie Anforderungsparameter. Geben Sie je nach API-Methode die erforderlichen Parameter für die Anforderung ein, z. B. Pfadparameter, Abfrageparameter, Header oder Text. Wenn eine API ein Authorization Token erfordert, müssen Sie es in den Header einschließen.

6. Senden Sie die Anforderung. Wählen Sie, nachdem Sie die Anforderungsdetails angegeben haben, Senden aus. Die Antwort von der API wird direkt im Azure-Portal angezeigt, einschließlich Antwortcode, Antworttext und aller Header.

7. Überprüfen Sie die Antwort. Überprüfen Sie die Antwortdaten, Statuscodes und eventuelle Fehlermeldungen, die auf Probleme mit der API oder der Anforderung hindeuten können.

Migrieren des einmaligen Anmeldens zu API Management

Wenn Sie einmaliges Anmelden (Single Sign-On, SSO) im API-Portal aktivieren und Anforderungen an API Management authentifizieren möchten, führen Sie die folgenden Schritte aus, um die Identität in API Management zu konfigurieren:

1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.

2. Navigieren Sie zu Entwicklerportal>Identitäten.

3. Wählen Sie Hinzufügen und dann Azure Active Directory aus.

4. Füllen Sie die Pflichtfelder aus:

   • Client-ID: die Anwendungs- oder Client-ID Ihrer registrierten Microsoft Entra ID-Anwendung
   • Geheimer Clientschlüssel: das Geheimnis der Microsoft Entra ID-Anwendung
   • Anmeldemandant: der Domänenname Ihres Microsoft Entra ID-Mandanten, z. B. yourcompany.onmicrosoft.com
   • Umleitungs-URL: normalerweise https://{your-apim-instance}.developer.azure-api.net/signin

5. Wählen Sie Hinzufügen aus, um den Identitätsanbieter zu speichern.

Sie müssen die Umleitungs-URL der Liste zulässiger Umleitungs-URLs Ihrer Microsoft Entra ID-Client-App hinzufügen, bevor Sie den neu hinzugefügten Identitätsanbieter speichern.

Weitere Konfigurationen für API Management finden Sie in der Dokumentation zu API Management.