Menelusuri dan memfilter API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Topik ini menjelaskan cara menggunakan Smart Search yang didukung oleh Vertex AI dan opsi penelusuran berbasis filter untuk menelusuri resource tertentu di hub API.

Anda dapat dengan mudah menemukan dan melihat resource API yang didaftarkan di hub API menggunakan Smart Search. Dengan Penelusuran Cerdas, Anda dapat menelusuri semua resource API yang tersedia di instance menggunakan kueri penelusuran teks bebas. Anda dapat menelusuri semua jenis entity (API, operasi API, spesifikasi, dll.), atau menentukan jenis entitas yang ingin Anda kueri.

Dengan mesin telusur Vertex AI, Smart Search dapat melakukan lebih dari sekadar "pencocokan" istilah. Smart Search menampilkan hasil yang berisi istilah yang ditemukan di mana saja dalam entri resource API mendetail yang secara semantik mirip dengan kueri penelusuran teks bebas yang dimasukkan.

Penelusuran teks bebas menampilkan daftar hasil penelusuran dengan penomoran halaman yang menyertakan detail berikut:

  • Resource name: Nama API, operasi API, atau file spesifikasi.
  • Deskripsi referensi: Deskripsi singkat tentang referensi.
  • Pemilik resource: Nama dan alamat email pemilik resource.
  • Link detail materi: Link ke halaman informasi mendetail untuk materi.

Untuk menelusuri API yang berisi istilah tertentu:

  1. Di konsol Google Cloud, buka halaman Discover hub API.

    Buka hub API Discover

  2. Ketik kueri penelusuran di kotak penelusuran.

    Misalnya, Anda dapat memasukkan "API pengelolaan pesanan" atau "File spesifikasi untuk setelan operator nirkabel".

    Anda dapat menyaring penelusuran menggunakan atribut sistem dalam perintah kueri penelusuran. Jika membuat atribut pengguna saat mendaftarkan API di hub API, Anda juga dapat memasukkan atribut ini ke dalam perintah kueri penelusuran.

  3. Daftar Search results akan menampilkan daftar resource API yang berisi istilah yang secara semantik mirip dengan kueri penelusuran yang Anda masukkan.
  4. Klik nama resource API untuk melihat halaman detail resource.
  5. Untuk menghapus kueri saat ini, klik Hapus hasil.

Anda juga dapat menelusuri resource hub API menggunakan API hub API. Metode searchResources memungkinkan Anda membuat kueri resource hub API menggunakan kueri dan filter teks bebas.

Anda dapat menggunakan panggilan API berikut untuk melakukan penelusuran di seluruh resource hub API: 

curl -X POST https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"QUERY",
    "filter":"resource_type = RESOURCE_TYPE"
   }'

Dengan keterangan:

  • PROJECT_ID adalah ID project host untuk instance hub API Anda.
  • LOCATION adalah lokasi tempat instance hub API Anda dihosting.
  • QUERY adalah kueri teks bebas yang digunakan dalam penelusuran. Kueri dapat berisi kata kunci yang terkait dengan detail resource hub API, termasuk nama tampilan, deskripsi, atau metadata lainnya.
  • RESOURCE_TYPE adalah filter opsional yang ditetapkan untuk penelusuran Anda. Anda dapat menentukan salah satu jenis resource hub API berikut sebagai filter:
    • Api
    • ApiOperation
    • Deployment
    • Definition
    • Spec
    • Version

Contoh: 

curl -X POST https://apihub.googleapis.com/v1/projects/{project-id}/locations/{location}:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"dog status in the store",
    "filter":"resource_type = SPEC"
    }'

Panggilan ini menampilkan daftar resource hub API yang telah dipaginasi, termasuk kode berikut:

  • Nama tampilan resource.
  • Deskripsi resource.
  • Link ke dokumentasi tentang referensi.
  • Pemilik resource.

Jika atribut sistem atau atribut pengguna tambahan dikonfigurasi untuk resource tersebut, metadata yang terkait dengan atribut tersebut juga akan ditampilkan.

Untuk informasi selengkapnya tentang penelusuran teks bebas dengan API hub API, lihat dokumentasi referensi API untuk Method:project.locations.searchResources.

Opsi penelusuran berbasis filter

Anda dapat menyaring daftar API yang ditampilkan di halaman API dengan menggunakan atribut sistem sebagai parameter penelusuran. Jika membuat atribut pengguna saat mendaftarkan API di hub API, Anda juga dapat memasukkan atribut-atribut ini dalam kueri penelusuran Anda. Sesuaikan daftar resource API yang ditampilkan menggunakan salah satu opsi berikut:

Filter

Dengan penelusuran daftar berbasis filter, Anda dapat menyederhanakan daftar API berdasarkan sejumlah parameter standar dan atribut sistem yang terkait dengan resource. Anda dapat menggunakan opsi Match ALL atau Match ANY untuk menyesuaikan tampilan yang difilter.

Untuk menentukan opsi filter:

  1. Di konsol Google Cloud, buka halaman APIs hub API.

    Buka API hub API

  2. Klik kolom Filter tabel untuk memfilter tabel. Panel Filter akan terbuka.
  3. Tentukan atau pilih opsi filter dari opsi berikut:
    • API name: Nama tampilan API
    • Dokumentasi: Link singkat ke dokumentasi API.
  4. Setelah memilih opsi filter, pilih nilai filter dari daftar Nilai. Atau, Anda dapat memasukkan nilai untuk atribut filter yang dipilih.
  5. Untuk menambahkan filter lain, klik kolom Tabel filter untuk memilih dari Operator yang tersedia, lalu pilih atribut dan nilai filter lain.

  6. Properti filter yang dipilih menampilkan logika kondisional yang digunakan kueri filter. Anda dapat memilih OR sebagai operator. Jika tidak ada operator yang dipilih, defaultnya adalah AND.

  7. Untuk menghapus filter satu per satu, klik X pada filter. Untuk menghapus semua filter, klik Hapus semua di panel Filter.

Urutkan

Untuk menyusun ulang daftar API yang ditampilkan:

  1. Di konsol Google Cloud, buka halaman APIs hub API.

    Buka API hub API

    Halaman daftar APIs ditampilkan secara default.

  2. Dari halaman daftar APIs, temukan judul kolom API name.
  3. Panah menunjukkan prioritas pengurutan saat ini. Panah bawah menunjukkan urutan abjad menurun. Panah ke atas menunjukkan urutan abjad menaik.
  4. Klik API name untuk mengurutkan daftar API berdasarkan nama.

Penomoran halaman

Jika ada beberapa resource API, resource tersebut dapat ditampilkan di beberapa halaman.

Untuk menyesuaikan tampilan daftar dan menavigasi antar-halaman:

  1. Di konsol Google Cloud, buka halaman APIs hub API.

    Buka API hub API

    Halaman daftar APIs ditampilkan secara default.

  2. Dari daftar API, cari alat penomoran halaman seperti yang ditunjukkan di bawah ini:

  3. Pilih jumlah API yang akan ditampilkan per halaman.
  4. Klik > Teruskan untuk membuka halaman berikutnya.
  5. Klik < Kembali untuk membuka halaman sebelumnya.

Apa langkah selanjutnya?