API-Ressourcen verwalten

Diese Seite gilt für Apigee und Apigee Hybrid.

API registrieren

Wenn Sie eine API beim API-Hub registrieren, erstellen und speichern Sie eine Entität, die die API darstellt. Diese Entität wird als API-Ressource bezeichnet. Im API-Hub gespeicherte API-Ressourcen können durchsucht werden und bieten detaillierte Betriebs- und beschreibende Informationen zur API. Sie können entweder bei der Registrierung einer API oder später API-Ressourcenattribute hinzufügen und bearbeiten, um eine ausführliche Beschreibung der API zu erstellen.

Console

So registrieren Sie eine API:

  1. Rufen Sie in der Google Cloud Console im Apigee API-Hub die Seite APIs auf.

    Zum API-Hub
  2. Klicken Sie auf API registrieren.

  3. Geben Sie unter Allgemeine Details optional eine eindeutige ID für die API an. Wenn Sie keine ID angeben, wird eine für Sie generiert. Wenn Sie eine ID eingeben möchten, klicken Sie auf Eindeutige ID angeben.

    Die ID muss zwischen 4 und 500 Zeichen lang sein und gültige Zeichen sind /[A-Z][a-z][0-9]-/.. Die ID ist die letzte Komponente des vollständig qualifizierten, eindeutigen API-Ressourcennamens im folgenden Format: projects/PROJECT/locations/LOCATION/apis/API_ID

  4. (Erforderlich) Geben Sie einen Anzeigenamen für die API-Ressource an.
  5. Fügen Sie optional zusätzliche Attribute hinzu, die die API beschreiben. Sie können jederzeit zur API zurückkehren, um API-Attribute hinzuzufügen oder zu ändern. Siehe API-Ressource bearbeiten.
    • Inhaberinformationen (optional): Der Name und die E-Mail-Adresse des API-Inhabers.
    • Zusätzliche Informationen (optional): Geben Sie Attribute an, um die API zu definieren und die Suche zu erleichtern. Sie können für einige dieser Attribute in den Einstellungen Standardwerte festlegen. Weitere Informationen finden Sie unter Attribute verwalten.
    • Benutzerdefinierte Attribute (Optional): Das sind Attribute, die Sie in den Einstellungen definieren. Weitere Informationen finden Sie unter Attribute verwalten.
  6. Klicken Sie auf Registrieren.

REST

Verwenden Sie zum Registrieren einer API die REST API Create API.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{
    "display_name": "DISPLAY_NAME",            # Required attribute
    "description": "DESCRIPTION"               # description is an optional attribute
    }
    'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis?api_id=API_ID

Ersetzen Sie Folgendes:

  • HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_ID: (Optional) Geben Sie eine eindeutige ID für die API ein. Wenn Sie diesen Abfrageparameter nicht angeben, generiert das System eine eindeutige ID für Sie. Die ID muss zwischen 4 und 500 Zeichen lang sein und gültige Zeichen sind /[A-Z][a-z][0-9]-/.. Die ID ist die letzte Komponente des vollständig qualifizierten, eindeutigen API-Ressourcennamens im folgenden Format: projects/PROJECT/locations/LOCATION/apis/API_ID
  • DISPLAY_NAME: (Erforderlich) Der Anzeigename der API-Ressource. Sie können einen beliebigen Namen verwenden.
  • DESCRIPTION: (Optional) Sie können eine Reihe optionaler Attribute hinzufügen, um die API-Ressource zu beschreiben, einschließlich einer Beschreibung, eines Inhabers, eines Links zur API-Dokumentation und mehr. Diese optionalen Attribute sind in der API-Ressourcendefinition aufgeführt und beschrieben.

API-Ressourcen auflisten

In diesem Abschnitt wird erläutert, wie Sie die API-Ressourcen im API-Hub auflisten. Durch Hinzufügen eines Filters können Sie die in der Antwort zurückgegebenen APIs einschränken.

Console

So listen Sie API-Ressourcen auf:

  1. Rufen Sie in der Google Cloud Console im Apigee API-Hub die Seite APIs auf.

    Zum API-Hub

    Eine Liste aller zum API-Hub hinzugefügten APIs wird auf der Startseite der APIs aufgeführt.

  2. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.

REST

Verwenden Sie die API List APIs, um alle API-Ressourcen in Ihrem API-Hub-Projekt aufzulisten:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis"
  -X GET -H "Authorization: Bearer: $(gcloud auth print-access-token)" -H "Content-Type: application/json"

Ersetzen Sie Folgendes:

  • HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.

Beispielausgabe:

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-2",
      "displayName": "TestApi2",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-1",
      "displayName": "TestApi1",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/foo9013cfev",
      "displayName": "sample",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/foo90121",
      "displayName": "sample",
      "documentation": {}
    },
    ...
    ],
    "nextPageToken": "f4f4d78b-a974-46db-a214-dc139f8e9c8a"
  }

REST-Beispiel mit Filter

Sie können Listenergebnisse mithilfe der API filtern. In diesem Beispiel filtern wir APIs anhand eines systemdefinierten Attributs: 

curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis' \
  -d filter="owner.email=\"testowner3@gmail.com\"" -d page_size=10

Ersetzen Sie Folgendes:

  • HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.

Nach Inhaber gefilterte Beispielausgabe:

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-central1/apis/theme-park-management-api",
      "displayName": "Theme Park Management API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/restaurant-api",
      "displayName": "Restaurant API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/casino-management-api",
      "displayName": "Casino Management API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/hotel-boooking-api",
      "displayName": "Hotel Booking API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api3",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api2",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api1",
      "displayName": "Test Pets API",
      "documentation": {}
    }
  ]
}

API-Ressourcendetails abrufen

In diesem Abschnitt wird erläutert, wie Sie die Details zu einer API-Ressource abrufen.

Console

So rufen Sie Details zu einer API-Ressource auf:

  1. Rufen Sie in der Google Cloud Console im Apigee API-Hub die Seite APIs auf.

    Zum API-Hub
  2. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  3. Klicken Sie auf eine API, um die zugehörige Detailseite anzusehen.

REST

Verwenden Sie die API API-Ressourcendetails abrufen, um Details zu einer API-Ressource anzuzeigen:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Ersetzen Sie Folgendes:

  • HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_ID: Die eindeutige ID der API-Ressource.

Beispielausgabe:

{
  "name": "projects/myproject/locations/us-central1/apis/myapi",
  "displayName": "My Test API",
  "description": "This is a test API.",
  "documentation": {},
  "owner": {
    "displayName": "Test API,
    "email": "testowner@gmail.com"
  },
  "versions": [
    "projects/myproject/locations/us-central1/apis/myapi/versions/myapi-version1"
  ],
  "createTime": "2024-03-26T10:13:15.668867002Z",
  "updateTime": "2024-03-26T10:13:16.700716401Z"
}

API-Ressource löschen

In diesem Abschnitt wird gezeigt, wie Sie eine API-Ressource löschen.

Console

Wenn Sie eine API in der Benutzeroberfläche löschen, werden alle zugrunde liegenden Versionen der API und gegebenenfalls die zugehörigen API-Spezifikationen gelöscht.

So löschen Sie eine API-Ressource:

  1. Rufen Sie in der Google Cloud Console im Apigee API-Hub die Seite APIs auf.

    Zum API-Hub
  2. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zum Löschen zu finden.
  3. Klicken Sie im Menü Aktionen (die rechte Seite der Zeile mit der API) auf Löschen.

REST

Verwenden Sie die Delete API API, um eine API aus dem API-Hub zu löschen:

Standardmäßig kann eine API nur gelöscht werden, wenn alle zugrunde liegenden Versionen gelöscht werden. Wenn Sie alle Versionen einer API in einem Schritt löschen möchten, legen Sie in der Delete REST API den Abfrageparameter force auf true fest.

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID'

Ersetzen Sie Folgendes:

  • HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_ID: Die eindeutige ID der zu löschenden API-Ressource.

Setzen Sie den Abfrageparameter force auf true, um die API und alle zugrunde liegenden Versionen zu löschen. Beispiel:

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID?force=true'

API-Ressource bearbeiten

In diesem Abschnitt wird gezeigt, wie Sie eine API-Ressource bearbeiten. Nicht alle API-Ressourcenattribute können bearbeitet werden. Eine Liste der bearbeitbaren Attribute finden Sie im Referenzdokument zur Patch API.

Console

So bearbeiten Sie eine API:

  1. Rufen Sie in der Google Cloud Console im Apigee API-Hub die Seite APIs auf.

    Zum API-Hub
  2. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Suche, um eine API zu finden, die Sie bearbeiten möchten.
  3. Klicken Sie auf eine API, um die zugehörige Detailseite anzusehen.
  4. Klicken Sie auf API bearbeiten.
  5. Nehmen Sie die Änderungen auf der Seite API bearbeiten vor. Klicken Sie auf Weiter, um zum nächsten Satz bearbeitbarer Attribute zu gelangen.
    • Allgemeine Details: Sie können den Anzeigenamen der API bearbeiten.
    • Inhaberinformationen: Der Name und die E-Mail-Adresse des API-Inhabers.
    • Zusätzliche Informationen: Dies sind die systemdefinierten Attribute. Sie können für diese Attribute unter Attribute verwalten benutzerdefinierte Standardwerte festlegen.
    • Benutzerdefinierte Attribute: Dies sind die benutzerdefinierten, benutzerdefinierten Attribute. Sie können benutzerdefinierte Attribute unter Attribute verwalten angeben.
  6. Klicken Sie auf Speichern.

REST

Verwenden Sie zum Bearbeiten einer API-Ressource die Patch API-Ressourcen-API.

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{
          "display_name": "Updated Test Docs API",        # Example request body with changes
          "description": "This is the updated test API.",
          "owner": {
            "display_name": "Updated Docs Owner",
            "email": "updateddocsowner@gmail.com"
            }
          }
          ' https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID

Ersetzen Sie Folgendes:

  • HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_ID: Die eindeutige ID der zu aktualisierenden API.
  • Anfragetext: Verwenden Sie den Anfragetext, um die Attribute anzugeben, die Sie ändern möchten. Siehe Beschreibung des API-Anfrage-Hauptteils.