API 仕様を検証する

このページは Apigee と Apigee ハイブリッドに適用されます。

API Hub には、API の OpenAPI 仕様を検証する組み込みの Spectral linter（バリデータ）が用意されています。OpenAPI 仕様を API バージョンに追加するとすぐに、バリデータ（デフォルトで有効）が仕様を検証し、検出結果を Google Cloud コンソールに表示します。

仕様の検証を無効にする

デフォルトでは、linter が有効になっています。linter を無効にするには、Google Cloud コンソールで [API Hub] > [設定] > [アクション] ページに移動し、[lint チェック] セクションで [lint チェック] オプションを無効にします。

スタイルガイド

スタイルガイドは、API Hub が OpenAPI 仕様を検証するルールのセットです。API Hub は、OpenAPI 仕様の検証にデフォルトのスタイルガイドを使用します。デフォルトのスタイルガイド ルールについては、OpenAPI ルールをご覧ください。

新しいスタイルガイドをアップロードする

コンソール

新しいスタイルガイドをアップロードするには、次の操作を行います。

  1. デフォルトのスタイルガイドを拡張して、新しいスタイルを作成します。詳細については、ルールセットを作成するをご覧ください。

  2. Google Cloud コンソールで、[API Hub] > [設定] > [アクション] ページに移動します。

  3. [lint チェック] セクションで、[新しいスタイル ドキュメントをアップロード] をクリックします。
  4. ステップ 1 で作成した新しいスタイル ドキュメントをアップロードして、[保存] をクリックします。

REST API

lint チェック用の新しいスタイルガイドをアップロードするには、次の API に PATCH リクエストを送信します。

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

API の詳細については、UpdateStyleGuide をご覧ください。

次の例は、スタイルガイドをアップロードする API 呼び出しを示しています。

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

デフォルトのスタイルガイドをダウンロードする

API Hub で lint チェックに使用されるデフォルトのスタイルガイドをダウンロードするには、次の操作を行います。

  1. Google Cloud コンソールで、[API Hub] > [設定] > [アクション] ページに移動します。

  2. [lint チェック] セクションで、[デフォルトのスタイル ドキュメントをダウンロード] をクリックします。これにより、ローカル システムにデフォルトのスタイル ドキュメントがダウンロードされます。

最新のスタイルガイドをダウンロードする

コンソール

API Hub で現在 lint チェックに使用されているスタイルガイドをダウンロードするには、次の操作を行います。

  1. Google Cloud コンソールで、[API Hub] > [設定] > [アクション] ページに移動します。

  2. [lint チェック] セクションで、[最新のスタイル ドキュメントをダウンロード] をクリックします。これにより、ローカル システムにデフォルトのスタイル ドキュメントがダウンロードされます。

REST API

API Hub で現在 lint チェックに使用されているスタイルガイドをダウンロードするには、次の API に GET リクエストを発行します。

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

API の詳細については、GetStyleGuide をご覧ください。

次の例は、現在のスタイルガイドをダウンロードする API 呼び出しを示しています。

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