Tutorial: Menentukan metadata kustom

Tutorial ini menjelaskan cara menentukan metadata kustom untuk membantu Anda mengatur API dan informasi lain di pusat API Anda. Anda dapat menggunakan metadata kustom dan bawaan untuk pencarian dan pemfilteran dan untuk menerapkan standar tata kelola di organisasi Anda.

Untuk informasi selengkapnya tentang metadata di Azure API Center, lihat:

• Konsep utama - Metadata
• Menggunakan metadata untuk tata kelola API

Dalam tutorial ini, Anda mempelajari cara menggunakan portal Microsoft Azure untuk:

• Menentukan metadata kustom di pusat API Anda
• Melihat skema metadata

Prasyarat

• Pusat API di langganan Azure Anda. Untuk membuatnya, lihat Mulai Cepat: Membuat pusat API Anda.

Menentukan metadata

Di sini Anda menentukan dua contoh metadata kustom: Lini bisnis dan Publik; jika mau, tentukan metadata Anda sendiri. Saat Anda menambahkan atau memperbarui API dan informasi lain dalam inventarisasi Anda, tetapkan 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.

1. Masuk ke portal Microsoft Azure, lalu navigasikan ke pusat API Anda.

2. Di menu bar samping, di bawah Aset, pilih Metadata>+ Metadata baru.

3. Pada tab Detail , masukkan informasi tentang metadata.

   1. Untuk Judul, masukkan Baris bisnis.

   2. Secara opsional, masukkan Deskripsi.

   3. 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.

   

4. Pada tab Penugasan , pilih Diperlukan untuk API. Pilih Opsional untuk Penyebaran dan Lingkungan. Anda dapat menambahkan entitas ini dalam tutorial selanjutnya. Pilih Selanjutnya.

   

5. Pada tab Tinjau + buat , tinjau pengaturan, dan pilih Buat.

   Metadata ditambahkan ke daftar di halaman Metadata .

6. Pilih + Metadata baru untuk menambahkan contoh lain.

7. Pada tab Detail , masukkan informasi tentang metadata.

   1. Untuk Judul, masukkan Terlihat oleh Publik.

   2. Pilih tipe Boolean.

8. Pada tab Penugasan , pilih Diperlukan untuk API. Pilih Tidak berlaku untuk Penyebaran dan Lingkungan.

9. 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.

1. Di menu sebelah kiri, di bawah Aset, pilih Metadata>Lihat skema metadata.

2. Pilih Lihat skema metadata>API 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 selanjutnya

Tambahkan API ke inventarisasi di pusat API Anda.

Mendaftarkan API di inventarisasi API Anda