Memvalidasi spesifikasi API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Hub API menyediakan Spectral linter (validator) bawaan yang memvalidasi spesifikasi OpenAPI API Anda. Segera setelah Anda menambahkan spesifikasi OpenAPI ke versi API, validator (yang diaktifkan secara default) akan memvalidasi spesifikasi, dan melaporkan temuannya di Konsol Google Cloud.

Nonaktifkan validasi spesifikasi

Secara default, linter diaktifkan. Untuk menonaktifkan linter, di Konsol Google Cloud, buka halaman API hub > Settings > Actions, lalu di bagian Linting, nonaktifkan opsi Linting.

{i>Style guide<i}

Panduan gaya adalah serangkaian aturan yang digunakan hub API untuk memvalidasi spesifikasi OpenAPI. Hub API menggunakan panduan gaya default untuk memvalidasi spesifikasi OpenAPI. Untuk aturan panduan gaya default, lihat Aturan OpenAPI.

Upload panduan gaya baru

Konsol

Untuk mengupload panduan gaya baru, lakukan langkah-langkah berikut:

  1. Buat gaya baru dengan memperluas panduan gaya default. Untuk mengetahui informasi selengkapnya, lihat Membuat kumpulan aturan.

  2. Di konsol Google Cloud, buka halaman API hub > Settings > Actions.

  3. Di bagian Linting, klik Upload new style document. Tindakan ini akan menampilkan panel Upload new style document.
  4. Upload dokumen gaya baru (dibuat di langkah 1), lalu klik Save.

REST API

Untuk mengupload panduan gaya baru untuk analisis lint, berikan permintaan PATCH ke API berikut:

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

Untuk informasi selengkapnya tentang API, lihat UpdateStyleGuide.

Contoh berikut menunjukkan panggilan API untuk mengupload panduan gaya.

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

Download panduan gaya default

Untuk mendownload panduan gaya default yang digunakan oleh hub API untuk analisis lint, lakukan langkah-langkah berikut:

  1. Di konsol Google Cloud, buka halaman API hub > Settings > Actions.

  2. Di bagian Linting, klik Download original style document. Tindakan ini akan mendownload dokumen gaya default ke sistem lokal Anda.

Download panduan gaya terbaru

Konsol

Untuk mendownload panduan gaya yang saat ini digunakan oleh hub API untuk analisis lint, lakukan langkah-langkah berikut:

  1. Di konsol Google Cloud, buka halaman API hub > Settings > Actions.

  2. Di bagian Linting, klik Download latest style document. Tindakan ini akan mendownload dokumen gaya default ke sistem lokal Anda.

REST API

Untuk mendownload panduan gaya yang saat ini digunakan oleh hub API untuk analisis lint, kirimkan permintaan GET ke API berikut:

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

Untuk mengetahui informasi selengkapnya tentang API, lihat GetStyleGuide.

Contoh berikut menampilkan panggilan API untuk mendownload panduan gaya saat ini.

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