APIs verwalten

Diese Seite gilt für Apigee und Apigee Hybrid.

API-Ressource 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 die Seite API-Hub auf.

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

  4. Geben Sie optional einen Namen für die API an. Wenn Sie keinen Namen angeben, wird ein Name für Sie generiert. Wenn Sie einen Namen eingeben möchten, klicken Sie auf Benutzerdefinierte ID angeben.

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

  5. Fügen Sie optional weitere Informationen zur API hinzu. Sie können jederzeit zur API zurückkehren, um API-Attribute hinzuzufügen oder zu ändern.
    • Zusätzliche Informationen (optional): Dies sind die systemdefinierten Attribute. Sie können für diese Attribute in den Einstellungen benutzerdefinierte Standardwerte festlegen.
    • Details zur Inhaberschaft (optional): Der Name und die E-Mail-Adresse des API-Inhabers.
    • Versionsdetails (optional): Geben Sie die ID einer Version an, die mit dieser API verknüpft werden soll. Siehe Versionsübersicht.
    • Attributdetails (optional): Dies sind die benutzerdefinierten, benutzerdefinierten Attribute. Sie können benutzerdefinierte Attribute in den Einstellungen angeben.
  6. Klicken Sie auf API 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 and owner are optional attributes
    "owner": {
      "display_name": "OWNER_DISPLAY_NAME",
      "email": "OWNER_EMAIL_ADDRESS"
      }
    }
    'https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_LOCATION/apis?api_id=API_NAME

Ersetzen Sie Folgendes:

  • API_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_NAME: (Optional) Geben Sie einen Namen für die API ein. Wenn Sie diesen Abfrageparameter nicht angeben, generiert das System einen Namen für Sie. Der Name muss zwischen 4 und 63 Zeichen lang sein und gültige Zeichen sind /[a-z][0-9]-/.. Der Name ist die letzte Komponente des vollständig qualifizierten, eindeutigen API-Ressourcennamens im folgenden Format: projects/PROJECT/locations/LOCATION/apis/ID
  • DISPLAY_NAME: (Erforderlich) Der Anzeigename der API-Ressource. Sie können einen beliebigen Namen verwenden.
  • Optionale Attribute: Sie können zusätzliche optionale Attribute für die API hinzufügen und diese in den Anfragetext einfügen oder sie später hinzufügen. Sie können beispielsweise eine Beschreibung, einen Inhaber und einen Link zur API-Dokumentation angeben. Weitere Informationen finden Sie in der API-Ressourcendefinition.

APIs 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 die Seite API-Hub auf.

    Zum API-Hub
  2. Klicken Sie auf APIs. Eine Liste aller zum API-Hub hinzugefügten APIs wird auf der Startseite der APIs aufgeführt.
  3. 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 APIs im API-Hub 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/common-dev-1/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-1",
      "displayName": "TestApi1",
      "documentation": {}
    },
    {
      "name": "projects/common-dev-1/locations/us-central1/apis/foo9013cfev",
      "displayName": "sample",
      "documentation": {}
    },
    {
      "name": "projects/common-dev-1/locations/us-central1/apis/foo90121",
      "displayName": "sample",
      "documentation": {}
    },
    ...
    ],
    "nextPageToken": "f4f4d78b-a974-46db-a214-dc139f8e9c8a"
  }

REST-Beispiel mit Filter

Sie können die Listenergebnisse wie in diesem Beispiel filtern:

curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_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/common-dev-1/locations/us-central1/apis/theme-park-management-api",
      "displayName": "Theme Park Management API",
      "documentation": {}
    },
    {
      "name": "projects/common-dev-1/locations/us-central1/apis/restaurant-api",
      "displayName": "Restaurant API",
      "documentation": {}
    },
    {
      "name": "projects/common-dev-1/locations/us-central1/apis/casino-management-api",
      "displayName": "Casino Management API",
      "documentation": {}
    },
    {
      "name": "projects/common-dev-1/locations/us-central1/apis/hotel-boooking-api",
      "displayName": "Hotel Booking API",
      "documentation": {}
    },
    {
      "name": "projects/common-dev-1/locations/us-central1/apis/test-march-26-api3",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/common-dev-1/locations/us-central1/apis/test-march-26-api2",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/common-dev-1/locations/us-central1/apis/test-march-26-api1",
      "displayName": "Test Pets API",
      "documentation": {}
    }
  ]
}

API-Details abrufen

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

Console

Auf der API-Detailseite können Sie eine API-Ressourcendefinition ansehen und bearbeiten, einschließlich Versionen, Spezifikationsdateien, Erweiterungen und Bereitstellungen.

So rufen Sie Details zu einer API auf:

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

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. 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_NAME"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json" \
  '{
    "display-name": "Test API",
    "owner": {
      "email": "testowner@gmail.com"
    }'

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_NAME: (Optional) Der Name 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 löschen

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

Console

So löschen Sie eine API-Ressource:

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

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Öffnen Sie das Aktionsmenü für die API (die rechte Seite der Zeile mit der API) und klicken Sie auf Löschen.

REST

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

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

Ersetzen Sie Folgendes:

  • API_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_NAME: Der Name der zu löschenden API-Ressource.

API-Ressource bearbeiten

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

Console

So bearbeiten Sie eine API:

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

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. Klicken Sie auf eine API, um die zugehörige Detailseite anzusehen.
  5. Auf der API-Detailseite können Sie Attribute bearbeiten und der API-Ressource Versionen hinzufügen. Weitere Informationen zum Hinzufügen von Versionen finden Sie unter API-Version erstellen.

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",        # Specify attributes to change in the request body
          "description": "This is test updated API.",
          "owner": {
            "display_name": "Updated Docs Owner",
            "email": "updateddocsowner@gmail.com"
            }
          }
          ' https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_LOCATION/apis/API_NAME

Ersetzen Sie Folgendes:

  • API_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
  • API_NAME: Der Name der zu aktualisierenden API.
  • Anfragetext: Verwenden Sie den Anfragetext, um die Attribute anzugeben, die Sie ändern möchten. Weitere Informationen finden Sie in der Beschreibung des API-Anfragetexts.