Menelusuri dan memfilter API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

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

Anda bisa dengan mudah menemukan dan melihat sumber daya API yang terdaftar di hub API menggunakan Penelusuran Cerdas. Penelusuran Cerdas memungkinkan 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 tentukan jenis entitas yang ingin Anda kueri.

Dengan mesin telusur Vertex AI, Penelusuran Cerdas tidak hanya sekadar "pencocokan" istilah. Smart Search menampilkan hasil berisi istilah yang ditemukan di mana pun dalam entri resource API mendetail yang secara semantik mirip dengan kueri penelusuran teks bebas yang dimasukkan.

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

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

Untuk menelusuri API yang berisi istilah tertentu:

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

    Buka Discover hub API

  2. Ketik kueri penelusuran di kotak penelusuran.

    Misalnya, Anda dapat memasukkan, "Order management API" atau "File spesifikasi untuk setelan operator nirkabel".

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

  3. Daftar Hasil penelusuran akan menampilkan daftar resource API yang berisi istilah yang mirip secara semantik ke kueri penelusuran yang dimasukkan.
  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 untuk melakukan kueri resource hub API menggunakan kueri dan filter teks bebas.

Anda dapat menggunakan panggilan API berikut untuk menelusuri 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 akan 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 diberi nomor halaman, termasuk hal berikut:

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

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

Untuk informasi selengkapnya tentang pencarian 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 menggunakan atribut sistem sebagai parameter penelusuran. Sesuaikan daftar resource API yang ditampilkan menggunakan salah satu cara berikut:

Filter

Dengan menggunakan penelusuran daftar berbasis filter, Anda dapat menyederhanakan daftar API berdasarkan sejumlah yang terkait dengan resource tersebut. 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 di kolom Filter tabel untuk memfilter tabel. Panel Filter akan terbuka.
  3. Tentukan atau pilih opsi filter. Saat Anda mengetik dalam panel {i>Filter<i}, sebuah menu dengan opsi {i>filter<i} muncul yang daftar atribut sistem yang relevan dengan konteks saat ini. Sebagai Sebagai contoh, berikut adalah atribut sistem yang mungkin Anda lihat saat memfilter API di halaman APIs:
    • API name: Nama tampilan API
    • Unit bisnis: Unit bisnis yang bertanggung jawab atas API
    • Tim: Tim produksi yang bertanggung jawab atas API
    • Dokumentasi: Link singkat ke dokumentasi API.

      • Anda akan melihat atribut sistem dalam daftar filter di bagian API, Versi, dan Tabel spesifikasi.

  4. Setelah memilih opsi filter, pilih nilai filter dari daftar Nilai. Sebagai alternatif, Anda dapat memasukkan nilai untuk atribut filter yang dipilih.
  5. Untuk menambahkan filter tambahan, klik di kolom Filter tabel untuk memilih dari Operator yang tersedia lalu pilih yang lain filter atribut dan nilai.

  6. Properti filter yang dipilih menampilkan atribut yang digunakan kueri filter. Anda dapat memilih OR sebagai operator. Jika tidak operator 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 API ditampilkan secara default.

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

Penomoran halaman

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

Untuk menyesuaikan tampilan daftar dan berpindah antarhalaman:

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

    Buka API hub API

    Halaman daftar API ditampilkan secara default.

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

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

Apa langkah selanjutnya?