API-Spezifikationen hochladen

Diese Seite gilt für Apigee und Apigee Hybrid.

Preview — Apigee API hub

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Es gibt zwei Möglichkeiten, einer registrierten API eine API-Spezifikation hinzuzufügen.

• Laden Sie eine Spezifikationsdatei hoch.
• Geben Sie den URI einer Spezifikationsdatei an.

API-Spezifikation hochladen

Sie können eine API-Spezifikation hochladen und einer registrierten API-Version hinzufügen. Wenn Sie eine API-Spezifikation hochladen, wird sie vom API-Hub geparst und die neue API-Ressource wird mit Metadaten aus der Spezifikation aktualisiert.

Hinweis : Sie können zwar Spezifikationen vom Typ „aaa“, „bbb“, „ccc“ und „OpenAPI“ hochladen, das Parsen wird jedoch nur für OpenAPI-Spezifikationen unterstützt.

In diesem Dokument wird erläutert, wie Sie einer API-Version eine API-Spezifikation hinzufügen.

API-Spezifikation hochladen

Console

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

   Zum API-Hub
2. Klicken Sie auf APIs.
3. Wählen Sie die registrierte API aus, die Sie aktualisieren möchten.
4. Klicken Sie auf Spezifikationsdatei hinzufügen.
5. Wählen Sie die Spezifikationsdatei mit einer der folgenden Methoden aus:
   • Suchen Sie im Bereich „Spezifikationsdatei“ nach der Spezifikationsdatei, die Sie hochladen möchten.
   • Geben Sie in das Feld „Ressourcen-URL“ die URL der Spezifikation ein, die Sie hochladen möchten.
6. Fügen Sie optional einen Namen für die Spezifikation hinzu.
7. Wählen Sie die API-Version aus, der die Spezifikationsdatei zugeordnet werden soll.
8. Wählen Sie den Spezifikationsdateityp aus, z. B. GraphQL, REST oder YAML.

REST

So fügen Sie eine API-Ressource mit der REST API hinzu:

POST https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/apis/ID/versions/VERSION/specs?specIdSPEC_ID

    {
      "displayName": "DISPLAYNAME",
      "contents": "SPEC_CONTENTS",
      "mimeType": "MIME_TYPE" 
    {
  

Ersetzen Sie Folgendes:

• PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
• LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
• ID: (Optional) Wenn Sie keine ID angeben, wird vom System eine ID erstellt. Die ID ist die letzte Komponente des schreibgeschützten API-Ressourcennamens. Sie hat das Format projects/PROJECT/locations/LOCATION/apis/ID.
• VERSION: (Erforderlich) Die Version der API-Ressource.
• SPEC_ID: (Optional) Eine ID für die Spezifikation. Wenn Sie diesen Abfrageparameter nicht angeben, wird eine vom System generierte ID für Sie erstellt.
• DISPLAYNAME: (Erforderlich) Der Anzeigename der API-Spezifikation. Sie können einen beliebigen Namen verwenden.
• SPEC_CONTENTS: (Erforderlich) Der Inhalt der Spezifikation als base64-codierter String. Max. Größe: 10 MB Es werden nur OpenAPI-Spezifikationen unterstützt.
• MIME_TYPE: (Erforderlich) Der MIME-Typ des Inhalts. zum Beispiel application/json, application/yaml, application/wsdl usw.

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 unter API Hub API.