Menggunakan metadata untuk tata kelola API

Artikel ini menyediakan informasi latar belakang tentang metadata dan cara menggunakannya untuk tata kelola API di Azure API Center. Anda menentukan dan mengatur metadata untuk mengatur dan memfilter API dan entitas lain di pusat API Anda. Metadata dapat dibangun ataukustom, dan Anda dapat mengembangkan skema metadata untuk memberlakukan konsistensi di seluruh API, lingkungan, dan penyebaran Anda.

Metadata bawaan

Saat membuat atau memperbarui API, lingkungan, dan penyebaran di pusat API, Anda mengatur properti metadata bawaan tertentu, seperti jenis API (REST, WSDL, dan sebagainya).

Tabel berikut mencantumkan metadata bawaan yang disediakan untuk entitas Azure API Center. Untuk detailnya, lihat referensi API Center REST API. Tabel tidak menyertakan properti Azure standar seperti pengidentifikasi sumber daya, judul tampilan, atau deskripsi. Tidak semua properti diperlukan.

Antarmuka Pemrograman Aplikasi (API)

Metainformasi	Description	Contoh nilai
jenis	Jenis (jenis) API	REST, SOAP, GraphQL
tahap siklus hidup	Tahap siklus hidup pengembangan API	Desain, pengembangan
lisensi	Informasi lisensi untuk API	Pengidentifikasi SPDX, tautan ke teks lisensi
dokumentasi eksternal	Situs untuk dokumentasi eksternal untuk API	URL yang menunjuk ke dokumentasi
informasi kontak	Titik kontak untuk API	Alamat email, nama, URL
ketentuan layanan	Ketentuan layanan untuk API	URL yang menunjuk ke ketentuan layanan

Environments

Metainformasi	Description	Contoh nilai
jenis	Jenis (jenis) lingkungan	Produksi, penahapan, pengembangan
server	Informasi server lingkungan	Jenis dan URL yang menunjuk ke server lingkungan
jenis server	Jenis server lingkungan	Server API Management, server Kubernetes, server Apigee
onboarding	Informasi onboarding untuk lingkungan	Instruksi dan URL yang menunjuk ke portal pengembang lingkungan

Penyebaran

Metainformasi	Description	Contoh nilai
server	Informasi server penyebaran	URL yang menunjuk ke server penyebaran
state	Status penyebaran	Aktif, tidak aktif

Metadata kustom

Tentukan metadata kustom menggunakan portal Microsoft Azure, AZURE API Center REST API, atau Azure CLI untuk membantu mengatur dan memfilter API, lingkungan, dan penyebaran di pusat API Anda. Azure API Center mendukung metadata kustom dari jenis berikut.

Tipe	Description	Contoh nama
Boolean	Benar atau salah	IsInternal
nomor/angka	Nilai numerik	YearOfCreation
string	Nilai teks	GitHubRepository
array	Daftar nilai	Tags
pilihan bawaan	Daftar pilihan bawaan	Department
objek	Objek kompleks terdiri dari beberapa jenis	APIApprover

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.

Menetapkan metadata ke entitas

Properti metadata kustom dapat ditetapkan ke API, lingkungan, atau penyebaran di pusat API Anda. Misalnya, Anda dapat menentukan dan menetapkan metadata Departemen ke API, sehingga ketika API terdaftar atau versi API baru ditambahkan, departemen yang bertanggung jawab atas API ditentukan.

Jika ditetapkan ke entitas, metadata bersifat opsional atau diperlukan. Misalnya, Anda mungkin mengharuskan metadata Departemen diatur hanya untuk API, tetapi memungkinkan YearOfCreation menjadi metadata opsional untuk lingkungan.

Nota

Tentukan metadata kustom kapan saja dan terapkan ke API dan entitas lain di pusat API Anda.
Setelah menentukan metadata kustom, Anda dapat mengubah penugasannya menjadi entitas, misalnya dari yang diperlukan menjadi opsional untuk API.
Anda dapat mengubah nilai metadata, tetapi Anda tidak dapat menghapus atau mengubah jenis metadata kustom yang saat ini diatur dalam API, lingkungan, dan penyebaran. Batalkan penentuan metadata kustom dari entitas terlebih dahulu, lalu Anda dapat menghapus atau mengubahnya.