Mengelola taksonomi

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Pratinjau — Apigee API hub

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.

Izin yang diperlukan: Anda harus memiliki izin administrator untuk melihat halaman Setelan dan mengelola taksonomi.

Taksonomi menyediakan cara untuk mengatur API dan menyediakan opsi fleksibel untuk menentukan metadata API. Taksonomi, seperti yang didefinisikan dalam sistem, hanyalah daftar nilai bernama yang memberikan opsi kategorisasi untuk informasi tertentu. Halaman setelan Taksonomi memungkinkan Anda melihat dan mengelola berbagai taksonomi yang tersedia di sistem.

Taksonomi sistem menentukan nilai yang memiliki makna khusus di hub API, dan dapat ditampilkan dengan cara khusus di UI atau perilaku dikte. Taksonomi sistem telah ditentukan sebelumnya oleh sistem dan cara taksonomi tersebut dapat diubah atau diperluas lebih dibatasi; namun, daftar nilainya dapat diubah hingga batas tertentu.

Taksonomi kustom menentukan informasi kustom yang ingin Anda kaitkan ke API. Jika memiliki izin administrator, Anda dapat membuat dan mengubah daftar ini dengan cara apa pun sesuai keinginan.

Sebagian besar taksonomi bersifat eksklusif; melabeli item ke dalam koleksi yang tidak tumpang tindih (pilihan tunggal). Namun, jika diperlukan, taksonomi dapat dikonfigurasi untuk memungkinkan beberapa label ditetapkan ke satu objek. Taksonomi multi-pilihan ini ditandai sedemikian rupa dalam konfigurasinya.

Taksonomi Sistem yang Telah Ditetapkan

Taksonomi sistem yang telah ditetapkan berikut tidak dapat dihapus dan memiliki bagian tertentu dari konfigurasi yang tidak dapat diedit. Beberapa taksonomi sistem yang telah ditentukan ini juga menentukan elemen yang telah ditentukan sebelumnya:

• Pengguna target: Pengguna yang dituju (konsumen) dari API (beberapa pilihan diizinkan)
• Gaya (primer): Gaya arsitektur utama API (khusus pilihan tunggal)
• Tim: Tim produksi yang bertanggung jawab atas API (hanya satu pilihan)
• Unit bisnis: Unit bisnis yang bertanggung jawab atas API (hanya satu pilihan)
• Gateway: Proxy yang digunakan untuk menayangkan dan melindungi API (khusus satu pilihan)

Taksonomi kustom

Taksonomi kustom menyediakan metode untuk melampirkan informasi kustom ke API. Contoh:

• Persetujuan: Status peninjauan, seperti Mematuhi atau Diatur oleh
• Topik: Kategorisasi API berdasarkan materi pokok, seperti Keuangan atau HR
• Atribut: Fitur API seperti Berisi PII
• Produk: Produk konsumen yang dirancang untuk didukung oleh API

Tambahkan taksonomi

Untuk menambahkan taksonomi:

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

   Buka taksonomi hub API

2. Klik Tambahkan taksonomi kustom.
3. Tentukan hal berikut:
   • ID: ID untuk resource API. ID hanya boleh berisi huruf kecil, angka, dan tanda hubung. ID dalam project harus unik. Panjang ID harus antara 4 dan 63 karakter. Nomor tidak dapat diubah setelah taksonomi dibuat. Misalnya, untuk nama resource API: projects/my-project/locations/global/apis/my-api, ID resource-nya adalah my-api.
   • Nama: Nama tampilan untuk taksonomi
   • Deskripsi: Deskripsi singkat untuk taksonomi
   • Opsi:
     • Batasi ke satu pilihan: Jika dipilih, hanya satu nilai taksonomi yang dapat diterapkan ke API pada waktu tertentu. Jika beberapa nilai sudah diterapkan ke API dan opsi ini diaktifkan, nilai tersebut akan tetap ada.
     • Kecualikan dari filter penelusuran: Jika dipilih, taksonomi ini tidak akan terlihat di panel Filter.
   • Elemen taksonomi: Daftar pasangan Nama dan Deskripsi atau URL yang menentukan nilai yang tersedia untuk taksonomi tersebut.
     • Nama: Nama akan otomatis dibuat berdasarkan nama tampilan taksonomi. Nama ini ditampilkan jika Anda mengarahkan mouse ke ikon info di halaman Overview.
     • URL: Jika URL dimasukkan, elemen taksonomi akan ditampilkan sebagai URL.
     • Klik Tambahkan elemen untuk menambahkan elemen lain.
4. Klik Simpan (atau Batal).

Catatan: Setiap kali Taksonomi sistem tidak ditetapkan di resource, nilai Not specified akan ditampilkan di UI. Komponen pemilihan taksonomi juga menampilkan Tidak ditetapkan sebagai opsi jika berlaku. Taksonomi dapat menjadi tidak ditetapkan, misalnya, jika taksonomi kustom dihapus.

Edit taksonomi

Untuk mengedit taksonomi:

1. Di Cloud Console, buka halaman API hub, Settings, Taxonomies.

   Buka taksonomi hub API

2. Klik Edit di samping taksonomi sistem, atau Lainnya > Edit di samping taksonomi kustom.

3. Buat perubahan seperlunya. Tidak semua kolom untuk Taksonomi sistem dapat diubah. Lihat Taksonomi Sistem Standar untuk informasi selengkapnya.

   Catatan: Jika menghapus Elemen taksonomi dari taksonomi mana pun, Anda akan melihat dialog konfirmasi yang menunjukkan bahwa nilai untuk taksonomi tersebut akan dihapus dari semua API yang saat ini menetapkan elemen tersebut.
4. Klik Simpan (atau Batal).

Hapus taksonomi

Perhatian: Menghapus taksonomi akan menghapusnya dari API yang menggunakan taksonomi tersebut.

Untuk menghapus taksonomi:

1. Di Cloud Console, buka halaman API hub, Settings, Taxonomies.

   Buka taksonomi hub API

2. Klik Lainnya > Hapus di samping taksonomi yang diinginkan.

   Catatan: Anda hanya dapat menghapus taksonomi kustom.
3. Klik Hapus (atau Batal) di permintaan konfirmasi.

Susun ulang daftar taksonomi

Taksonomi dapat diubah urutannya untuk menentukan urutan kemunculannya di panel Filter API dan halaman Overview API.

Untuk menyusun ulang daftar taksonomi:

1. Di Cloud Console, buka halaman API hub, Settings, Taxonomies.

   Buka taksonomi hub API

2. Klik panah atas atau bawah hingga siklus proses berada di posisi yang diinginkan.