APIs registrieren

Sie lesen die Dokumentation zu Apigee X.
Apigee Edge-Dokumentation aufrufen

Vorschau –Apigee API hub

Diese Funktion unterliegt den Nutzungsbedingungen des Pre-GA-Angebots der Google Cloud-Nutzungsbedingungen. Pre-GA-Funktionen werden möglicherweise nur eingeschränkt unterstützt. Änderungen an Pre-GA-Funktionen sind möglicherweise nicht mit anderen Pre-GA-Versionen kompatibel. Weitere Informationen finden Sie unter Beschreibungen der Startphase.

Durch die Registrierung einer API wird diese für Betrachter in der API-Liste sichtbar.

Erforderliche Berechtigungen: Sie benötigen die Bearbeitungs- oder Administratorberechtigungen zum Registrieren, Bearbeiten oder Löschen von API-Registrierungen.

API registrieren

So registrieren Sie eine API:

1. Gehen Sie in der Cloud Console zur Seite Apigee API-Hub.

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie auf API registrieren. Der Bereich API registrieren wird geöffnet.
3. Geben Sie die folgenden API-Details an:
   • ID: Eine Kennung für eine API-Ressource. Die ID darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten. Die ID muss im Projekt eindeutig sein. IDs müssen zwischen 4 und 63 Zeichen lang sein. IDs können nach der Registrierung einer API nicht mehr geändert werden. Für den API-Ressourcennamen projects/my-project/locations/global/apis/my-api lautet die Ressourcen-ID beispielsweise my-api.
   • Name: Geben Sie den API-Namen ein.
   • Beschreibung: Geben Sie die API-Beschreibung ein.
   • Stil:
   • Stil: Wählen Sie den primären Architekturstil der API aus, z. B. OpenAPI, GraphQL, AsyncAPI usw., abhängig von der Konfiguration des API-Hubs.
   • API-Beschreibungsdokument: Wenn Sie ein vorhandenes Beschreibungsdokument haben, klicken Sie auf Durchsuchen, um es hochzuladen. Dies kann eine einzelne Datei oder eine ZIP-Datei (max. 2 MB) sein. Informationen zum Hinzufügen und Löschen von Überarbeitungen finden Sie unter Überarbeitungen verwalten.
   • MIME-Typ: Wählen Sie einen MIME-Typ aus. MIME-Typ wird angezeigt, nachdem Sie ein API-Beschreibungsdokument ausgewählt haben. Wenn Sie Andere auswählen, wird ein Textfeld angezeigt, in dem Sie den MIME-Typ manuell angeben können.
   • Aktuelle Version:
     • Versions-ID: Ein Name für eine API-Ressource. Die Versions-ID darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten. Die Versions-ID muss im Projekt eindeutig sein. Versions-IDs müssen zwischen 1 und 63 Zeichen lang sein. Versions-IDs können nach der Registrierung einer API nicht mehr geändert werden.
     • Version: Geben Sie die erste Version ein.
     • API-Lebenszyklusphase: Wählen Sie eine Lebenszyklusphase aus der Liste aus.
   • Erwartetes End of Life:
     • Wählen Sie eine Erwartung aus der Liste aus.
     • Wenn für Erwartet das Mindestdatum ausgewählt ist, geben Sie ein Datum an.
     • Wenn für Erwartet das Datum der Bestätigung ausgewählt ist, geben Sie ein Datum an.
   • Attribute:
     • Systemtaxonomien:

       • Zielnutzer: Wählen Sie die gewünschten Nutzer für die API aus.

       • Team: Wählen Sie das Team aus, das für die Erstellung der API zuständig ist.
       • Geschäftseinheit: Wählen Sie die für die API zuständige Geschäftseinheit aus.
     • Benutzerdefinierte Taxonomien:
       Hinweis: Es können weitere benutzerdefinierte Attribute verfügbar sein.
       • Alle anderen benutzerdefinierten Taxonomien auswählen
   • Primärer Kontakt:
     • E-Mail-Adresse des primären Kontakts: Die E-Mail-Adresse des primären Kontakts für Fragen zur API.
     • Beschreibung des primären Kontakts: Die Beschreibung des primären Kontakts
4. Klicken Sie auf API registrieren (oder Abbrechen).

API-Registrierungsdaten bearbeiten

So bearbeiten Sie API-Registrierungsdaten:

1. Gehen Sie in der Cloud Console zur Seite Apigee API-Hub.

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie auf eine API. Die Seite API-Übersicht wird geöffnet.
3. Klicken Sie auf  Bearbeiten.
   Erforderliche Berechtigungen: Wenn der Link Bearbeiten nicht angezeigt wird, haben Sie keine Bearbeitungsberechtigungen.
4. Ändern Sie die Daten.
5. Klicken Sie auf Speichern (oder Abbrechen).

API löschen

Hinweis: Jede API muss eine empfohlene Version haben, die nicht gelöscht werden kann.

Eine gelöschte API wird aus dem System entfernt. Wenn die API für andere Nutzer von Interesse sein kann, sollten Sie sie als Lebenszyklusstatus Nicht mehr verfügbar oder Verworfen verwenden, statt sie zu löschen.

So löschen Sie eine API:

1. Gehen Sie in der Cloud Console zur Seite Apigee API-Hub.

   Zum API-Hub

   Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

2. Klicken Sie auf eine API. Die Seite API-Übersicht wird geöffnet.
   
3. Klicken Sie auf API löschen.
   Erforderliche Berechtigungen: Wenn der Link API löschen nicht angezeigt wird, haben Sie keine Bearbeitungsberechtigungen.

4. Es wird ein Bestätigungsdialogfeld angezeigt. Geben Sie den API-Namen ein und klicken Sie dann auf Bestätigen (oder Abbrechen).