Gambaran umum portal pengembang

Portal pengembang adalah situs web yang dibuat secara otomatis dan dapat disesuaikan sepenuhnya dengan dokumentasi API Anda. Di sinilah konsumen API dapat menemukan API Anda, mempelajari cara menggunakannya, meminta akses dan mencobanya.

Seperti yang diperkenalkan dalam artikel ini, Anda dapat menyesuaikan dan memperluas portal pengembang untuk skenario spesifik Anda.

Portal pengembang API Management

Ketersediaan

Penting

Fitur ini tersedia di tingkat Premium, Standar, Dasar, dan Pengembang API Management.

Bermigrasi dari portal warisan

Penting

Portal pengembang warisan sekarang tidak digunakan lagi dan hanya akan menerima pembaruan keamanan. Anda dapat terus menggunakannya, seperti biasa, hingga masa pensiunnya pada bulan Oktober 2023, ketika portas tersebut akan dihapus dari semua layanan API Management.

Migrasi ke portal pengembang baru dijelaskan dalam artikel dokumentasi khusus.

Menyesuaikan dan menata portal terkelola

Layanan API Management Anda mencakup portal pengembang terkelola bawaan yang selalu diperbarui. Anda dapat mengaksesnya dari antarmuka portal Microsoft Azure.

Menyesuaikan dan mengatur gaya portal terkelola melalui editor visual bawaan, seret dan letakkan:

  • Gunakan editor visual untuk mengubah halaman, media, tata letak, menu, gaya, atau pengaturan situs web.

  • Manfaatkan widget bawaan untuk menambahkan teks, gambar, tombol, dan objek lain yang didukung portal secara langsung.

  • Kontrol bagaimana konten portal muncul untuk pengguna dan grup yang berbeda yang dikonfigurasi dalam instans API Management Anda. Misalnya, tampilkan halaman tertentu hanya ke grup yang terkait dengan produk tertentu, atau kepada pengguna yang dapat mengakses API tertentu.

Catatan

Portal pengembang terkelola menerima dan menerapkan pembaruan secara otomatis. Perubahan yang telah Anda simpan tetapi tidak diterbitkan ke portal pengembang tetap dalam status tersebut selama pembaruan.

Opsi untuk memperluas fungsionalitas portal

Dalam beberapa kasus, Anda mungkin memerlukan fungsionalitas di luar opsi penyesuaian dan pengaturan gaya yang didukung di portal pengembang terkelola. Jika Anda perlu menerapkan logika kustom, yang tidak didukung secara langsung, Anda memiliki beberapa opsi:

  • Tambahkan HTML kustom secara langsung melalui widget portal pengembang yang dirancang untuk penyesuaian kecil - misalnya, tambahkan HTML untuk formulir atau untuk menyematkan pemutar video. Kode kustom dirender dalam bingkai sebaris (IFrame).
  • Buat dan unggah widget kustom untuk mengembangkan dan menambahkan fitur portal kustom yang lebih kompleks.
  • Host sendiri portal, hanya jika Anda perlu melakukan modifikasi pada inti basis kode portal pengembang. Opsi ini memerlukan konfigurasi tingkat lanjut. Bantuan Dukungan Azure hanya terbatas pada penyiapan dasar portal yang dihosting sendiri.

Catatan

Karena basis kode portal pengembang API Management dipertahankan di GitHub, Anda dapat membuka masalah dan membuat permintaan pull terhadap tim API Management untuk menggabungkan fungsionalitas baru kapan saja.

Langkah berikutnya

Pelajari selengkapnya tentang portal pengembang:

Jelajahi sumber daya lainnya: