Freigeben über

Tutorial: Hinzufügen von Umgebungen und Bereitstellungen für APIs

  • Artikel

Erweitern Sie den Bestand in Ihrem API Center, indem Sie Informationen zu API-Umgebungen und -Bereitstellungen hinzufügen.

  • Eine Umgebung stellt einen Speicherort dar, an dem eine API-Laufzeit bereitgestellt werden kann, z. B. eine API-Verwaltungsplattform.

  • Eine Bereitstellung ist ein Ort (eine Adresse), an dem Benutzer auf eine API zugreifen können.

Hintergrundinformationen zu APIs, Bereitstellungen und anderen Entitäten, die Sie im Azure API Center inventarisieren können, finden Sie unter Wichtige Konzepte.

In diesem Tutorial erfahren Sie, wie Sie das Portal für Folgendes verwenden:

  • Hinzufügen von Informationen zu API-Umgebungen
  • Hinzufügen von Informationen zu API-Bereitstellungen

Voraussetzungen

Hinzufügen einer Umgebung

Verwenden Sie Ihre API Center-Instanz, um den Überblick über Ihre realen API-Umgebungen zu behalten. Sie können beispielsweise Azure API Management oder eine andere Lösung verwenden, um einige Ihrer APIs zu verteilen, zu schützen und zu überwachen. Oder Sie können einige APIs direkt mit einem Computedienst oder einem Kubernetes-Cluster bereitstellen.

Hier fügen Sie Ihrer API Center-Instanz Informationen zu einer fiktiven Azure API Management-Umgebung hinzu. Wenn Sie möchten, fügen Sie Informationen zu einer Ihrer vorhandenen Umgebungen hinzu. Sie konfigurieren sowohl integrierte Metadaten als auch benutzerdefinierte Metadaten, die Sie in einem vorherigen Tutorial definiert haben.

  1. Navigieren Sie im Portal zu Ihrem API-Center.

  2. Wählen Sie im linken Menü unter Ressourcen Umgebungen>+ Neue Umgebung aus.

  3. Fügen Sie auf der Seite Neue Umgebung die folgenden Informationen hinzu. Wenn Sie zuvor die benutzerdefinierten Branchenmetadaten oder andere Metadaten definiert haben, die Umgebungen zugewiesen sind, werden sie unten auf der Seite angezeigt.

    Einstellung Wert Beschreibung
    Umgebungstitel Geben Sie Meine Tests ein. Name, den Sie für die Umgebung auswählen.
    Identifikation Nachdem Sie den vorangehenden Titel eingegeben haben, generiert das Azure API Center diesen Bezeichner, den Sie überschreiben können. Azure-Ressourcenname für die Umgebung.
    Umgebungstyp Wählen Sie Testen aus der Dropdownliste aus. Typ der Umgebung für APIs.
    Beschreibung Geben Sie optional eine Beschreibung ein. Die Beschreibung der Umgebung.
    Server
    Typ Wählen Sie optional Azure API Management aus der Dropdownliste aus. Typ der verwendeten API-Verwaltungslösung.
    Verwaltungsportal-URL Geben Sie optional eine URL für eine Verwaltungsschnittstelle ein, z. B. https://admin.contoso.com URL der Verwaltungsschnittstelle für die Umgebung.
    Onboarding
    URL des Entwicklungsportals Geben Sie optional eine URL für ein Entwicklerportal ein, z. B. https://developer.contoso.com URL der Schnittstelle für das Onboarding von Entwicklern in der Umgebung.
    Anweisungen Wählen Sie optional Bearbeiten aus, und geben Sie Onboardinganweisungen im Standard-Markdown ein. Anweisungen zum Onboarding von APIs aus der Umgebung.
    Branchenanwendung Wenn Sie diese benutzerdefinierten Metadaten hinzugefügt haben, treffen Sie optional eine Auswahl aus der Dropdownliste, z. B. IT. Benutzerdefinierte Metadaten, die die Geschäftseinheit identifizieren, die die Umgebung verwaltet.

    Screenshot: Hinzufügen einer API-Umgebung im Portal

  4. Klicken Sie auf Erstellen. Die Umgebung wird in der Liste der Umgebungen angezeigt.

Hinzufügen einer Bereitstellung

Das API-Center kann Ihnen auch helfen, Ihre API-Bereitstellungen zu katalogisieren – die Laufzeitumgebungen, in denen die von Ihnen nachverfolgten APIs bereitgestellt werden.

Hier fügen Sie eine Bereitstellung hinzu, indem Sie eine Ihrer APIs der Umgebung zuordnen, die Sie im vorherigen Abschnitt erstellt haben. Sie konfigurieren sowohl integrierte Metadaten als auch benutzerdefinierte Metadaten, die Sie definiert haben.

  1. Navigieren Sie im Portal zu Ihrem API-Center.

  2. Wählen Sie im linken Menü unter Ressourcen die Option APIs aus.

  3. Wählen Sie eine API aus, z. B. die Conference-API.

  4. Wählen Sie auf der Seite Conference-API unter Details die Option Bereitstellungen>+ Bereitstellung hinzufügen aus.

  5. Fügen Sie auf der Seite Bereitstellung hinzufügen die folgenden Informationen hinzu. Wenn Sie zuvor die benutzerdefinierten Branchenmetadaten oder andere Metadaten definiert haben, die Umgebungen zugewiesen sind, werden sie unten auf der Seite angezeigt.

    Einstellung Wert BESCHREIBUNG
    Titel Geben Sie Bereitstellung von v1 ein. Name, den Sie für die Bereitstellung auswählen.
    Identifikation Nachdem Sie den vorangehenden Titel eingegeben haben, generiert das Azure API Center diesen Bezeichner, den Sie überschreiben können. Azure-Ressourcenname für die Bereitstellung.
    Beschreibung Geben Sie optional eine Beschreibung ein. Beschreibung des Bereitstellung.
    Umgebung Treffen Sie eine Auswahl aus der Dropdownliste, z. B. Meine Tests, oder wählen Sie optional Neue erstellen aus. Neue oder vorhandene Umgebung, in der die API-Version bereitgestellt wird.
    Definition Wählen Sie eine Definitionsdatei für eine Version der Conference-API aus, oder fügen Sie sie hinzu. API-Definitionsdatei.
    URL der Runtime Geben Sie eine Basis-URL ein, z. B. https://api.contoso.com. Basis-Runtime-URL für die API in der Umgebung.
    Branchenanwendung Wenn Sie diese benutzerdefinierten Metadaten hinzugefügt haben, treffen Sie optional eine Auswahl aus der Dropdownliste, z. B. IT. Benutzerdefinierte Metadaten, die die Geschäftseinheit identifizieren, die die APIs in der Umgebung verwaltet.

    Screenshot: Hinzufügen einer API-Bereitstellung im Portal

  6. Klicken Sie auf Erstellen. Die Bereitstellung wird in der Liste der Bereitstellungen angezeigt.

In diesem Tutorial haben Sie erfahren, wie Sie das Portal für Folgendes verwenden:

  • Hinzufügen von Informationen zu API-Umgebungen
  • Hinzufügen von Informationen zu API-Bereitstellungen

Zugehöriger Inhalt