Versionen verwalten

Diese Seite gilt für Apigee und Apigee Hybrid.

In diesem Thema wird erläutert, wie Sie API-Versionen erstellen und verwalten. Weitere Informationen zu Versionen finden Sie unter Versionsübersicht.

Version zu einer API hinzufügen

Sie können einer vorhandenen API in der Console oder mit der REST API eine API-Version hinzufügen.

Console

So fügen Sie eine neue Version hinzu:

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

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Suchen Sie die API, die Sie versionieren möchten. 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örigen Details aufzurufen.
  5. Klicken Sie auf dem Tab Versionen auf Version hinzufügen.
  6. Geben Sie die Versionsdetails im Formular Neue Version hinzufügen an. Sie müssen einen Anzeigenamen angeben. Die anderen Attribute sind optional. Weitere Informationen zu Attributen finden Sie unter Attribute verwalten.
    • Name: (erforderlich) Sie müssen einen Anzeigenamen angeben.
    • Beschreibung: Fügen Sie eine Beschreibung der Version hinzu.
    • Lebenszyklus: Wählen Sie die Lebenszyklusphase der API aus.
    • Compliance: Wählen Sie ein Complianceattribut aus.
    • Akkreditierung: Wählen Sie ein Akkreditierungsattribut aus.
    • Dokumentation: Geben Sie die URL zur Dokumentation für die API ein.
    • Spezifikationsdatei hinzufügen: Importieren Sie eine API-Spezifikationsdatei, die mit der Version verknüpft werden soll. Weitere Informationen finden Sie unter API-Spezifikation zu einer Version hinzufügen.
    • Mit einem Deployment verknüpfen: Wählen Sie ein oder mehrere Deployments aus, die mit der API verknüpft werden sollen.
    • Benutzerdefinierte Attribute: Benutzerdefinierte Attribute sind Attribute, die Sie basierend auf den Anforderungen Ihrer Organisation oder Ihres Teams definieren. Siehe Nutzerattribute.
  7. Klicken Sie auf Erstellen.

REST

So fügen Sie eine neue Version mit der API API-Version erstellen hinzu:

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

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, der die Version hinzugefügt werden soll.
  • VERSION_ID: (Optional) Die ID der API-Version. Wenn nicht angegeben, wird eine vom System generierte ID verwendet. Der Name muss ein String mit 4 bis 63 Zeichen sein, wobei gültige Zeichen /[a-z][0-9]-/. sind.
  • DISPLAY_NAME: (Erforderlich) Der Anzeigename der Version. Sie können einen beliebigen Namen verwenden.
  • DESCRIPTION: (Optional) Sie können eine Reihe optionaler Attribute hinzufügen, um die Version zu beschreiben, z. B. eine Beschreibung, einen Inhabernamen, einen Link zur Dokumentation und mehr. Diese optionalen Attribute werden in der Definition der Versionsressourcen aufgelistet und beschrieben.

Beispielausgabe:

{
  "name": "projects/myproject/locations/myproject/apis/docs-api-1/versions/myversion1",
  "displayName": "My Version 1",
  "createTime": "2024-04-02T18:48:41.162360Z",
  "updateTime": "2024-04-02T18:48:41.162360Z"
}

API-Versionen auflisten

In diesem Abschnitt wird erläutert, wie Sie die mit einer registrierten API verknüpften Versionen auflisten.

Console

So rufen Sie alle Versionen auf, die mit einer registrierten API in der Console verknüpft sind:

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

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Suchen Sie die API, die Sie untersuchen möchten. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. API auswählen.
  5. Die Versionen sind auf der Detailseite der API in der Tabelle Versionen aufgelistet.

REST

So lassen Sie alle mit einer registrierten API verknüpften Versionen mithilfe der API-Versionen auflisten-API anzeigen:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions"
  -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.
  • API_ID: Die eindeutige ID der API-Ressource.

Beispielausgabe:

{
  "versions": [
    {
      "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
      "displayName": "Streetcarts Test v1"
    }
  ]
}

API-Versionsdetails abrufen

In diesem Abschnitt wird erläutert, wie Sie die Details zu einer API-Version abrufen, einschließlich der Attribute, Vorgänge, Bereitstellungen und Spezifikationsdateien.

Console

So rufen Sie die Versionsdetails in der Console auf:

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

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Suchen Sie die API, die Sie untersuchen möchten. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. API auswählen.
  5. Klicken Sie in der Tabelle Versionen auf eine Version, um die Seite mit den Versionsdetails aufzurufen.

REST

So rufen Sie Details zu einer Version mit der Get API Version Details API auf:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_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.
  • VERSION_ID: Die eindeutige ID der Version.

Beispielausgabe:

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1",
  "displayName": "Test Version 3",
  "documentation": {},
  "specs": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/specs/docs-spec-1"
  ],
  "apiOperations": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/listpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/createpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/deletepet",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/getpetbyid",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/updatepet"
  ],
  "definitions": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/definitions/pet"
  ],
  "createTime": "2024-04-04T14:53:57.299213423Z",
  "updateTime": "2024-04-04T14:53:58.027321138Z"
}

API-Version löschen

In diesem Abschnitt wird erläutert, wie Sie eine mit einer API-Ressource verknüpfte API-Version löschen. Sie können eine Version nur dann löschen, wenn zuerst alle zugrunde liegenden Spezifikationen, Vorgänge, Definitionen und verknüpften Bereitstellungen gelöscht werden.

Console

So löschen Sie eine Version:

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

    Zum API-Hub
  2. Klicken Sie auf APIs.
  3. Suchen Sie die API, die die zu löschende Version enthält. Verwenden Sie Filter, um Suchbegriffe anzugeben, um die Liste der APIs zu filtern. Verwenden Sie bei Bedarf Search, um eine API zu finden.
  4. API auswählen.
  5. Suchen Sie in der Tabelle Versionen die Version, die Sie löschen möchten.
  6. Klicken Sie im Menü Aktionen (rechts in der Zeile mit der Version) auf Löschen.

REST

So löschen Sie eine Version mit der API-Version 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_ID/versions/VERSION_ID'

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_ID: Die eindeutige ID der API-Ressource.
  • VERSION_ID: Die ID der zu löschenden Version.

Version bearbeiten

Console

So bearbeiten Sie eine Version:

  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. Wählen Sie eine API aus.
  5. Suchen Sie in der Tabelle Versionen die Version, die Sie bearbeiten möchten.
  6. Wählen Sie rechts neben der Versionszeile im Menü Aktionen die Option Bearbeiten aus. Sie können das Bearbeitungsfeature auch aufrufen, indem Sie auf der Seite mit den Versionsdetails auf Version bearbeiten klicken. Um die Detailseite aufzurufen, klicken Sie einfach auf eine Version in der Versionstabelle.
  7. Nachdem Sie die Änderungen vorgenommen haben, klicken Sie auf Speichern, um die Änderungen zu speichern. Eine Beschreibung der bearbeitbaren Attribute finden Sie in der Beschreibung der Versionsressource in der REST API-Referenz.

REST

So bearbeiten Sie eine Version mit der REST API:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID?updateMask=LIST_OF_ATTRIBUTES"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
    '{
      "display-name": DISPLAY_NAME,  # Use the request body to specify attribute changes
      "description": "DESCRIPTION"

    }'

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 mit der Version, die Sie bearbeiten möchten.
  • VERSION_ID: Die ID der zu bearbeitenden Version.
  • DESCRIPTION: Sie können im Anfragetext weitere bearbeitbare Attribute wie die Beschreibung und andere hinzufügen. Die bearbeitbaren Attribute sind in der Apigee Hub API-Referenz aufgeführt. Die Patch Version API.
  • LIST_OF_ATTRIBUTES: eine durch Kommas getrennte Liste vollständig qualifizierter Attributnamen. Beispiel: ?updateMask="description".

Beispielausgabe: 

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
  "displayName": "Streetcarts Test v1",
  "description": "This is a revision of the test version.",
  "documentation": {},
  "createTime": "2024-04-18T19:57:11.870761Z",
  "updateTime": "2024-04-18T20:23:42.465324Z"
}