Tutorial: Menentukan metadata kustom
Dalam tutorial ini, tentukan metadata kustom untuk membantu Anda mengatur API dan informasi lain di pusat API Anda. Gunakan metadata kustom dan bawaan untuk pencarian dan pemfilteran dan untuk menerapkan standar tata kelola di organisasi Anda.
Untuk informasi latar belakang tentang metadata di Azure API Center, lihat:
Dalam tutorial ini, Anda mempelajari cara menggunakan portal untuk:
- Menentukan metadata kustom di pusat API Anda
- Menampilkan skema metadata
Prasyarat
- Pusat API di langganan Azure Anda. Jika Anda belum membuatnya, lihat Mulai Cepat: Membuat pusat API Anda.
Menentukan metadata
Di sini Anda menentukan dua contoh metadata kustom: Lini bisnis dan Menghadap publik; jika mau, tentukan metadata Anda sendiri. Saat menambahkan atau memperbarui API dan informasi lain dalam inventarisasi, Anda akan menetapkan nilai untuk metadata kustom dan bawaan umum apa pun.
Penting
Jangan sertakan informasi sensitif, rahasia, atau pribadi dalam judul (nama) metadata yang Anda tentukan. Judul ini terlihat dalam log pemantauan yang digunakan oleh Microsoft untuk meningkatkan fungsionalitas layanan. Namun, detail dan nilai metadata lainnya adalah data pelanggan Anda yang dilindungi.
Di portal Azure, navigasikan ke pusat API Anda.
Di menu sebelah kiri, di bawah Aset, pilih Metadata > + Metadata baru.
Pada tab Detail , masukkan informasi tentang metadata.
Di Judul, masukkan Baris bisnis.
Secara opsional, masukkan Deskripsi.
Pilih jenis Pilihan yang telah ditentukan sebelumnya dan masukkan pilihan seperti Pemasaran, Keuangan, IT, Penjualan, dan sebagainya. Secara opsional aktifkan Izinkan pemilihan beberapa nilai. Pilih Selanjutnya.
Pada tab Penugasan , pilih Diperlukan untuk API. Pilih Opsional untuk Penyebaran dan Lingkungan. (Anda akan menambahkan entitas ini dalam tutorial selanjutnya.) Pilih Berikutnya.
Pada tab Tinjau + buat , tinjau pengaturan dan pilih Buat.
Metadata ditambahkan ke daftar di halaman Metadata .
Pilih + Metadata baru untuk menambahkan contoh lain.
Pada tab Detail , masukkan informasi tentang metadata.
Di Judul, masukkan Menghadap publik.
Pilih ketik Boolean.
Pada tab Penugasan , pilih Diperlukan untuk API. Pilih Tidak berlaku untuk Penyebaran dan Lingkungan.
Pada tab Tinjau + buat , tinjau pengaturan dan pilih Buat.
Metadata ditambahkan ke daftar.
Menampilkan skema metadata
Anda dapat melihat dan mengunduh skema JSON untuk metadata yang ditentukan di pusat API Anda. Skema ini mencakup metadata bawaan dan kustom.
Di menu sebelah kiri, di bawah Aset, pilih Skema metadata Tampilan Metadata>.
Pilih Tampilkan API skema > metadata untuk melihat skema metadata untuk API, yang mencakup metadata bawaan dan kustom. Anda juga dapat melihat skema metadata yang ditentukan untuk penyebaran dan lingkungan di pusat API Anda.
Langkah berikutnya
Dalam tutorial ini, Anda mempelajari cara menggunakan portal untuk:
- Menentukan metadata kustom di pusat API Anda
- Menampilkan skema metadata
Setelah menyiapkan skema metadata, tambahkan API ke inventarisasi di pusat API Anda.