Tutorial: Registrieren von APIs in Ihrem API-Inventar

Starten Sie in diesem Tutorial das API-Inventar im API Center Ihrer Organisation, indem Sie APIs registrieren und Metadaten mithilfe des Azure-Portals zuweisen.

Hintergrundinformationen zu APIs, API-Versionen, -Definitionen und anderen Entitäten, die Sie in Azure API-Center inventarisieren können, finden Sie unter Wichtige Konzepte.

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

Voraussetzungen

• Ein API-Center in Ihrem Azure-Abonnement. Wenn Sie noch keins erstellt haben, lesen Sie die Schnellstartanleitung: Erstellen Ihres API-Centers.

• Mindestens eine API, die Sie in Ihrem API-Center registrieren möchten. Hier sind zwei Beispiele mit Links zu den zugehörigen OpenAPI-Definitionen aufgeführt:

  • Swagger Petstore-API
  • Konferenz-API

• Führen Sie das vorherige Tutorial Definieren von benutzerdefinierten Metadaten durch, um benutzerdefinierte Metadaten für Ihre APIs zu definieren.

Registrieren von APIs

Wenn Sie eine API im API Center registrieren (hinzufügen), umfasst die API-Registrierung Folgendes:

• Titel (Name), Typ und Beschreibung
• Versionsinformationen
• Optionale Links zu Dokumentation und Kontakten
• Integrierte und benutzerdefinierte Metadaten, die Sie definiert haben

Nach der Registrierung einer API können Sie der API Versionen und Definitionen hinzufügen.

In den folgenden Schritten werden zwei Beispiel-APIs registriert: Swagger Petstore-API und Conference-API (siehe Voraussetzungen). Wenn Sie möchten, registrieren Sie eigene APIs.

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

2. Wählen Sie im linken Menü unter Ressourcen APIs>+ API registrieren aus.

3. Fügen Sie auf der Seite eine API registrieren die folgenden Informationen für die Swagger Petstore-API hinzu. Unten auf der Seite sehen Sie die benutzerdefinierten Branchen- und Öffentlichen Metadaten, die Sie im vorherigen Tutorial unten auf der Seite definiert haben.

   Einstellung	Wert	BESCHREIBUNG
   API-Titel	Geben Sie Swagger Petstore-API ein.	Der Name, den Sie für die API 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 API.
   API-Typ	Wählen Sie REST aus der Dropdownliste aus.	Art der API.
   Zusammenfassung	Geben Sie optional eine Zusammenfassung ein.	Eine zusammenfassende Beschreibung der API.
   Beschreibung	Geben Sie optional eine Beschreibung ein.	Beschreibung der API.
   Version
   Versionstitel	Geben Sie einen Versionstitel Ihrer Wahl ein, z. B. v1.	Der Name, den Sie für die API-Version auswählen.
   Versionsidentifikation	Nachdem Sie den vorangehenden Titel eingegeben haben, generiert das Azure API Center diesen Bezeichner, den Sie überschreiben können.	Azure-Ressourcenname für die Version.
   Versionslebenszyklus	Treffen Sie eine Auswahl aus der Dropdownliste, z. B. Testen oder Produktion.	Lebenszyklusphase der API-Version.
   Externe Dokumentation	Fügen Sie optional einen oder mehrere Links zur externen Dokumentation hinzu.	Name, Beschreibung und URL der Dokumentation für die API.
   Lizenz	Fügen Sie optional Lizenzinformationen hinzu.	Name, URL und ID einer Lizenz für die API.
   Kontaktinformationen	Fügen Sie optional Informationen für einen oder mehrere Kontakte hinzu.	Name, E-Mail-Adresse und URL eines Kontakts für die API.
   Branchenanwendung	Wenn Sie diese Metadaten im vorherigen Tutorial hinzugefügt haben, treffen Sie eine Auswahl aus der Dropdownliste, z. B. Marketing.	Benutzerdefinierte Metadaten, welche die Geschäftseinheit identifiziert, die Besitzer der API ist.
   Öffentlich	Wenn Sie diese Metadaten hinzugefügt haben, aktivieren Sie das Kontrollkästchen.	Benutzerdefinierte Metadaten, die angeben, ob die API öffentlich oder nur intern ist.

   

4. Klicken Sie auf Erstellen. Die API ist registriert.

5. Wiederholen Sie die vorherigen drei Schritte, um eine andere API zu registrieren, z. B. die Conference-API.

Die APIs werden im Portal auf der Seite APIs angezeigt. Wenn Sie dem API-Center eine große Anzahl von APIs hinzugefügt haben, verwenden Sie das Suchfeld und die Filter auf dieser Seite, um die gewünschten APIs zu finden.

Nach dem Registrieren einer API können Sie die Eigenschaften der API anzeigen oder bearbeiten. Wählen Sie auf der Seite APIs die API aus, um Seiten zum Verwalten der API-Registrierung anzuzeigen.

Hinzufügen einer API-Version

Während des gesamten Lebenszyklus kann eine API mehrere Versionen haben. Sie können einer vorhandenen API in Ihrer API Center-Instanz eine Version hinzufügen, optional mit einer oder mehreren Definitionsdateien.

Hier fügen Sie einer Ihrer APIs eine Version hinzu:

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

2. Wählen Sie im Menü auf der linken Seite APIs und dann eine API aus, z. B. Swagger Petstore.

3. Wählen Sie auf der Seite „API“ unter Details die Option Versionen>+ Version hinzufügen aus.

   

4. Gehen Sie auf der Seite API-Version hinzufügen folgendermaßen vor:

   1. Geben Sie die folgenden Informationen an:

      Einstellung	Wert	BESCHREIBUNG
      Versionstitel	Geben Sie einen Versionstitel Ihrer Wahl ein, z. B. v2.	Der Name, den Sie für die API-Version auswählen.
      Versionsidentifikation	Nachdem Sie den vorangehenden Titel eingegeben haben, generiert das Azure API Center diesen Bezeichner, den Sie überschreiben können.	Azure-Ressourcenname für die Version.
      Versionslebenszyklus	Treffen Sie eine Auswahl aus der Dropdownliste, z. B. Produktion.	Lebenszyklusphase der API-Version.

   2. Klicken Sie auf Erstellen. Die Version wird hinzugefügt.

Hinzufügen einer Definition zu Ihrer Version

In der Regel sollten Sie Ihrer API-Version eine API-Definition hinzufügen. Azure API-Center unterstützt Definitionen in gängigen Textspezifikationsformaten, z. B. OpenAPI 2 und 3 für REST-APIs.

So fügen Sie Ihrer Version eine API-Definition hinzu:

1. Wählen Sie auf der Seite Versionen Ihrer API Ihre API-Version aus.

2. Wählen Sie im linken Menü Ihrer API-Version unter Details Definitionen>+ Definition hinzufügen aus.

3. Auf der Seite Definition hinzufügen:

   1. Geben Sie die folgenden Informationen an:

      Einstellung	Wert	BESCHREIBUNG
      Titel	Geben Sie einen Titel Ihrer Wahl ein, z. B. v2-Definition.	Der Name, den Sie für die API-Definition 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 Definition.
      Beschreibung	Geben Sie optional eine Beschreibung ein.	Beschreibung der API-Definition.
      Spezifikationsname	Wählen Sie für die Petstore-API OpenAPI aus.	Spezifikationsformat für die API.
      Spezifikationsversion	Geben Sie den gewünschten Versionsbezeichner ein, z. B. 3.0.	Spezifikationsversion.
      Document	Navigieren Sie zu einer lokalen Definitionsdatei für die Petstore-API, oder geben Sie eine URL ein. Beispiel-URL: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	API-Definitionsdatei.

      

   2. Klicken Sie auf Erstellen. Die Definition wird hinzugefügt.

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

Nutzen Sie beim Erstellen Ihres API-Inventars automatisierte Tools zum Registrieren von APIs, z. B. die Azure API Center-Erweiterung für Visual Studio Code und die Azure CLI.

Nächste Schritte

Ihr API-Bestand nimmt langsam Gestalt an! Jetzt können Sie Informationen über API-Umgebungen und -Bereitstellungen hinzufügen.