Memvalidasi spesifikasi API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Pratinjau — Apigee API hub linting feature

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dalam Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

API hub 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 tersebut, dan melaporkan temuan di konsol Google Cloud.

Catatan: Dalam topik ini, istilah linting dan validating digunakan secara bergantian. Kedua istilah ini memiliki arti yang sama.

Menonaktifkan validasi spesifikasi

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

Panduan gaya

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

Catatan: Untuk menambahkan aturan kustom Anda sendiri, Anda harus membuat panduan gaya baru yang memperluas panduan gaya default. Setelah menambahkan aturan kustom di panduan gaya baru, Anda harus mengupload panduan gaya baru di API hub.

Mengupload panduan gaya baru

Konsol

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

1. Buat gaya baru dengan memperluas panduan gaya default. Untuk informasi selengkapnya, lihat Membuat kumpulan aturan.
   Catatan: Langkah validasi yang dilakukan pada upload akan menampilkan error jika URL muncul di properti extends dari kumpulan aturan Anda. Misalnya, ini adalah konstruksi properti ilegal dan akan menyebabkan upload gagal: extends: [spectral:oas", "https://mystyle.com/"].

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

3. Di bagian Linting, klik Upload new style document.
4. Upload dokumen gaya baru (yang dibuat di langkah 1), lalu klik Simpan.

REST API

Untuk mengupload panduan gaya baru untuk linting, buat 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.

Catatan: Langkah validasi yang dilakukan pada upload akan menampilkan error jika URL muncul di properti extends dari kumpulan aturan Anda. Misalnya, ini adalah konstruksi properti ilegal dan akan menyebabkan upload gagal: extends: [spectral:oas", "https://mystyle.com/"].

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 API hub untuk linting, lakukan langkah-langkah berikut:

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

2. Di bagian Linting, klik Download dokumen gaya default. 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 API hub untuk linting, lakukan langkah-langkah berikut:

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

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

REST API

Untuk mendownload panduan gaya yang saat ini digunakan oleh API hub untuk linting, buat permintaan GET ke API berikut:

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

Untuk informasi selengkapnya tentang API, lihat GetStyleGuide.

Contoh berikut menunjukkan 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