API-Spezifikationen validieren

Diese Seite gilt für Apigee und Apigee Hybrid.

Vorschau — Apigee API hub linting feature

Diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Funktionen sind „wie besehen“ verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

Der API-Hub bietet einen integrierten Spectral Linter (Validator), der die OpenAPI-Spezifikation Ihrer API validiert. Kurz nachdem Sie Ihrer API-Version eine OpenAPI-Spezifikation hinzugefügt haben, validiert der standardmäßig aktivierte Validator die Spezifikation und meldet die Ergebnisse in der Google Cloud Console.

Hinweis: In diesem Thema werden die Begriffe linting und validating synonym verwendet. Beide Begriffe haben dieselbe Bedeutung.

Spezifikationsprüfung deaktivieren

Standardmäßig ist der Linter aktiviert. Rufen Sie in der Google Cloud Console die Seite API-Hub > Einstellungen > Aktionen auf und deaktivieren Sie im Abschnitt Linting die Option Linting, um den Linter zu deaktivieren..

Styleguide

Ein Styleguide ist eine Reihe von Regeln, anhand derer der API-Hub eine OpenAPI-Spezifikation validiert. Der API-Hub verwendet einen Standard-Styleguide zur Validierung der OpenAPI-Spezifikationen. Die Standardregeln des Styleguides finden Sie unter OpenAPI-Regeln.

Hinweis: Wenn Sie eigene benutzerdefinierte Regeln hinzufügen möchten, müssen Sie einen neuen Styleguide erstellen, der den Standard-Styleguide erweitert. Nachdem Sie Ihre benutzerdefinierten Regeln im neuen Styleguide hinzugefügt haben, müssen Sie den neuen Styleguide in API-Hub hochladen.

Neuen Styleguide hochladen

Console

So laden Sie einen neuen Styleguide hoch:

1. Erstellen Sie einen neuen Stil, indem Sie den Standard-Styleguide erweitern. Weitere Informationen finden Sie unter Regelsatz erstellen.
   Hinweis:Bei einem Validierungsschritt, der beim Upload ausgeführt wird, wird ein Fehler ausgegeben, wenn eine URL in der extends-Eigenschaft Ihrer Regelliste enthalten ist. Das folgende Beispiel zeigt eine unzulässige Property-Struktur, die zum Fehlschlagen des Uploads führt: extends: [spectral:oas", "https://mystyle.com/"].

2. Rufen Sie in der Google Cloud Console die Seite API-Hub > Einstellungen > Aktionen auf.

3. Klicken Sie im Bereich Linting auf Neues Style-Dokument hochladen.
4. Laden Sie das neue Stildokument (in Schritt 1 erstellt) hoch und klicken Sie dann auf Speichern.

REST API

Zum Hochladen eines neuen Styleguides für Linting senden Sie eine PATCH-Anfrage an die folgende API:

https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/plugins/standard-linter/styleGuide?update_mask=contents

Weitere Informationen zur API finden Sie unter UpdateAttribute.

Hinweis:Bei einem Validierungsschritt, der beim Upload ausgeführt wird, wird ein Fehler ausgegeben, wenn eine URL in der extends-Eigenschaft Ihrer Regelliste enthalten ist. Das folgende Beispiel zeigt eine unzulässige Gebäudestruktur, die zum Fehlschlagen des Uploads führt: extends: [spectral:oas", "https://mystyle.com/"].

Das folgende Beispiel zeigt den API-Aufruf zum Hochladen eines Styleguides.

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"name":"projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide",
"contents":{  "contents": "ZXh0ZW5kczogWyJzcGVjdHJhbDpvYXMiXQo=",
  "mimeType": "text/yaml"}}' \ 
-X PATCH \
https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide?update_mask=contents  

Standard-Styleguide herunterladen

So laden Sie den standardmäßigen Styleguide herunter, der vom API-Hub für das Linting verwendet wird:

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

2. Klicken Sie im Abschnitt Linting auf Standardstildokument herunterladen. Dadurch wird das Standardstildokument auf Ihr lokales System heruntergeladen.

Aktuellen Styleguide herunterladen

Console

So laden Sie den Styleguide herunter, der derzeit vom API-Hub für das Linting verwendet wird:

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

2. Klicken Sie im Abschnitt Linting auf Neuestes Stildokument herunterladen. Dadurch wird das Standardstildokument auf Ihr lokales System heruntergeladen.

REST API

Um den Styleguide herunterzuladen, der derzeit vom API-Hub für Linting verwendet wird, senden Sie eine GET-Anfrage an die folgende API:

https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/plugins/standard-linter/styleGuide:contents

Weitere Informationen zur API finden Sie unter GetStyleGuide.

Das folgende Beispiel zeigt den API-Aufruf zum Herunterladen des aktuellen Styleguides.

curl -X \
GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide:contents