Mengaktifkan dan melihat tampilan portal Azure API Center - Ekstensi Visual Studio Code

Artikel ini memperlihatkan cara menyediakan akses pengembang perusahaan ke tampilan portal Azure API Center di ekstensi Visual Studio Code untuk Azure API Center. Dengan menggunakan tampilan portal, pengembang dapat menemukan API di pusat Api Azure Anda, melihat definisi API, dan secara opsional menghasilkan klien API saat mereka tidak memiliki akses untuk mengelola pusat API itu sendiri atau menambahkan API ke inventarisasi. Akses ke tampilan portal PUSAT API dikelola menggunakan ID Microsoft Entra dan kontrol akses berbasis peran Azure.

Petunjuk / Saran

Ekstensi Visual Studio Code menyediakan lebih banyak fitur untuk pengembang API yang memiliki izin untuk mengelola pusat Api Azure. Misalnya, pengembang API dapat mendaftarkan API di pusat API secara langsung atau menggunakan alur CI/CD. Pelajari lebih lanjut

Prasyarat

Untuk administrator pusat API

• Pusat API di langganan Azure Anda. Jika Anda belum membuatnya, lihat Panduan Cepat: Membuat Pusat API Anda.

• Izin untuk membuat pendaftaran aplikasi di penyewa Microsoft Entra yang terkait dengan langganan Azure Anda, dan izin untuk memberikan akses ke data di pusat API Anda.

Untuk pengembang aplikasi

• Ekstensi Azure API Center untuk Visual Studio Code

Ekstensi Visual Studio Code berikut bersifat opsional:

• Ekstensi Microsoft Kiota - untuk menghasilkan klien API
• GitHub Copilot dan GitHub Copilot Chat, disediakan dengan akses ke GitHub Copilot - untuk menggunakan alat model bahasa dalam mode agen untuk menemukan API

Langkah-langkah bagi administrator pusat API untuk mengaktifkan akses ke tampilan portal API Center

Bagian berikut ini menyediakan langkah-langkah bagi administrator pusat API untuk memungkinkan pengembang perusahaan mengakses tampilan portal API Center.

Membuat pendaftaran aplikasi Microsoft Entra

Pertama, konfigurasikan pendaftaran aplikasi di tenant Microsoft Entra ID Anda. Pendaftaran aplikasi memungkinkan portal API Center mengakses data dari pusat API Anda atas nama pengguna yang masuk.

API Center dapat menyiapkan pendaftaran aplikasi secara otomatis, atau Anda dapat membuat pendaftaran aplikasi secara manual.

Menyiapkan pendaftaran aplikasi secara otomatis

Untuk menyiapkan pendaftaran aplikasi secara otomatis, ikuti langkah-langkah berikut:

1. Di portal Azure, navigasikan ke pusat API Anda.
2. Di menu sebelah kiri, pilih portal API Center>Pengaturan.
3. Pada tab Penyedia identitas , pilih Mulai siapkan.
4. Pada tab Penyiapan cepat , pilih Simpan + terbitkan.

Jika Anda perlu mengakses pendaftaran aplikasi nanti, Anda dapat menemukannya di portal di bawah Pendaftaran aplikasi. Aplikasi ini diberi nama dengan format berikut: <api-center-name-apic-aad>.

Menyiapkan pendaftaran aplikasi secara manual

Jika Anda ingin membuat pendaftaran aplikasi secara manual, ikuti langkah-langkah berikut:

1. Di portal Microsoft Azure, buka Microsoft Entra ID>Kelola>Pendaftaran aplikasi.

2. Pilih + Pendaftaran baru.

3. Pada halaman Daftarkan aplikasi, atur nilai sebagai berikut:

   1. Atur Nama ke nama yang bermakna seperti api-center-portal
   2. Di bawah Jenis akun yang didukung, pilih Akun dalam direktori organisasi ini saja (<Nama> direktori - Penyewa tunggal).
   3. Di URI Pengalihan, pilih Aplikasi halaman tunggal (SPA) dan atur URI. Masukkan URI penyebaran portal API Center Anda, dalam formulir berikut: https://<service-name>.portal.<location>.azure-apicenter.ms. Ganti <service name> dan <location> dengan nama pusat API Anda dan lokasi tempatnya disebarkan, Contoh: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Pilih Daftarkan.

Mengonfigurasi URI pengalihan tambahan untuk ekstensi Visual Studio Code

Saat mengaktifkan tampilan portal API Center di ekstensi Visual Studio Code untuk API Center, konfigurasikan juga URI pengalihan berikut dalam pendaftaran aplikasi:

1. Di portal Microsoft Azure, buka pendaftaran aplikasi Anda.

2. Pada halaman Kelola>Autentikasi , pilih Tambahkan platform dan pilih Aplikasi seluler dan desktop.

3. Konfigurasikan tiga URI pengalihan kustom berikut:
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Ganti <application-client-id> dengan ID aplikasi (klien) aplikasi ini. Anda dapat menemukan nilai ini di halaman Gambaran Umum pendaftaran aplikasi.

Mengaktifkan masuk ke tampilan portal API Center oleh pengguna dan grup Microsoft Entra

Pengembang perusahaan harus masuk dengan akun Microsoft untuk melihat tampilan portal API Center untuk pusat API Anda. Jika diperlukan, tambahkan atau undang pengembang ke penyewa Microsoft Entra Anda.

Untuk mengaktifkan masuk ke portal API Center untuk mengakses API, tetapkan peran Azure API Center Data Reader kepada pengguna atau grup di organisasi Anda, yang tercakup ke pusat API Anda.

Penting

Secara default, Anda dan administrator pusat API lainnya harus masuk untuk mengakses API di portal API Center. Pastikan untuk menetapkan peran Azure API Center Data Reader kepada diri Anda sendiri dan administrator lainnya.

Untuk prasyarat dan langkah-langkah terperinci untuk menetapkan peran kepada pengguna dan grup, lihat Menetapkan peran Azure menggunakan portal Microsoft Azure. Langkah-langkah singkat berikut:

1. Di portal Azure, navigasikan ke pusat API Anda.
2. Di menu sebelah kiri, pilih Kontrol akses (IAM)>+ Tambahkan penetapan peran.
3. Di panel Tambahkan penetapan peran , atur nilai sebagai berikut:
   1. Pada halaman Peran, cari dan pilih Azure API Center Data Reader. Pilih Selanjutnya.
   2. Pada halaman Anggota, pada Tetapkan akses ke, pilih Pengguna, grup, atau perwakilan layanan>+ Pilih anggota.
   3. Pada halaman Pilih anggota , cari dan pilih pengguna atau grup untuk menetapkan peran. Klik Pilih lalu Berikutnya.
   4. Tinjau penetapan peran, dan pilih Tinjau + tambahkan.

Nota

Untuk menyederhanakan konfigurasi akses bagi pengguna baru, kami sarankan Anda menetapkan peran ke grup Microsoft Entra dan mengonfigurasi aturan keanggotaan grup dinamis. Untuk mempelajari selengkapnya, lihat Membuat atau memperbarui grup dinamis di ID Microsoft Entra.

Setelah Anda mengonfigurasi akses ke portal, pengguna yang dikonfigurasi dapat masuk ke portal dan melihat API di pusat API Anda.

Nota

Pengguna pertama yang masuk ke portal diminta untuk menyetujui izin yang diminta oleh pendaftaran aplikasi portal API Center. Setelah itu, pengguna lain yang dikonfigurasi tidak diminta untuk menyetujui.

Langkah-langkah bagi pengembang perusahaan untuk mengakses tampilan portal API Center

Pengembang dapat mengikuti langkah-langkah ini untuk menyambungkan dan masuk ke tampilan portal API Center menggunakan ekstensi Visual Studio Code. Pengaturan untuk menyambungkan ke pusat API perlu disediakan oleh administrator pusat API. Setelah menyambungkan, pengembang dapat menemukan dan menggunakan API di pusat API.

Menyambungkan ke pusat API

1. Di Visual Studio Code, di Bilah Aktivitas di sebelah kiri, pilih API Center.

   

2. Gunakan pintasan keyboard Ctrl+Shift+P untuk membuka Palet Perintah. Ketik Azure API Center: Sambungkan ke API Center dan tekan Enter.

3. Jawab perintah untuk memasukkan informasi berikut:

   1. URL runtime pusat API Anda, dalam format <service name>.data.<region>.azure-apicenter.ms (jangan awali dengan https://). Contoh: contoso-apic.data.eastus.azure-apicenter.ms. URL runtime ini muncul di halaman Gambaran Umum pusat API di tampilan portal Microsoft Azure.

   2. ID aplikasi (klien) dari pendaftaran aplikasi yang dikonfigurasi oleh administrator di bagian sebelumnya.

   3. ID direktori (tenant) dari pendaftaran aplikasi yang telah dikonfigurasi oleh administrator di bagian sebelumnya.

   Petunjuk / Saran

   Administrator pusat API perlu memberikan detail koneksi sebelumnya kepada pengembang, atau menyediakan tautan langsung dalam format berikut:
   vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

   Setelah Anda tersambung ke pusat API, nama pusat API muncul di tampilan portal API Center.

4. Untuk melihat API di pusat API, di bawah nama pusat API, pilih Masuk ke Azure. Masuk diizinkan dengan akun Microsoft yang diberi peran Azure API Center Data Reader di pusat API.

   

5. Setelah masuk, pilih API untuk mencantumkan API di pusat API. Perluas API untuk menjelajahi versi dan definisinya.

   

6. Ulangi langkah-langkah sebelumnya untuk menyambungkan ke lebih banyak pusat API, jika akses dikonfigurasi.

Menemukan dan menggunakan API dalam tampilan portal API Center

Tampilan portal API Center membantu pengembang perusahaan menemukan detail API dan memulai pengembangan klien API. Pengembang dapat mengakses fitur berikut dengan mengklik kanan definisi API dalam tampilan portal API Center:

• Ekspor dokumen spesifikasi API - Ekspor spesifikasi API dari definisi lalu unduh sebagai file
• Hasilkan klien API - Gunakan ekstensi Microsoft Kiota untuk menghasilkan klien API untuk bahasa favorit mereka
• Hasilkan Markdown - Hasilkan dokumentasi API dalam format Markdown
• Dokumentasi OpenAPI - Lihat dokumentasi untuk definisi API dan coba operasi di antarmuka pengguna Swagger (hanya tersedia untuk definisi OpenAPI)

Menggunakan alat model bahasa

Pengembang dengan akses ke tampilan portal API Center dapat menambahkan alat model bahasa API Center untuk digunakan dalam mode agen GitHub Copilot. Pelajari selengkapnya tentang menggunakan alat dalam mode agen.

Alat API Center dapat digunakan dalam mode agen untuk membantu mencari API dan versi API, definisi dan spesifikasi API, penyebaran, dan lainnya menggunakan perintah bahasa alami.

Untuk menambahkan dan menggunakan alat mode bahasa API Center dalam mode agen GitHub Copilot:

1. Sambungkan ke pusat API seperti yang dijelaskan di bagian sebelumnya.

2. Buka GitHub Copilot Chat di Visual Studio Code.

3. Atur mode pada GitHub Copilot Chat menjadi Agent.

4. Pilih ikon Alat di jendela obrolan.

   

5. Pilih satu atau beberapa alat API Center yang akan tersedia di obrolan.

   

6. Masukkan perintah di jendela obrolan untuk menggunakan alat yang tersedia. Contohnya:

   Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
   

7. Tinjau respons dari GitHub Copilot Chat. Lanjutkan dengan percakapan untuk menyempurnakan hasil atau mengajukan pertanyaan tindak lanjut.

Pemecahan masalah

Tidak dapat masuk ke Azure

Jika pengguna yang telah diberi peran Pembaca Data Azure API Center tidak dapat menyelesaikan alur masuk setelah memilih Masuk ke Azure dalam tampilan portal API Center, mungkin ada masalah dengan konfigurasi koneksi.

Periksa pengaturan dalam pendaftaran aplikasi yang Anda konfigurasikan di ID Microsoft Entra. Konfirmasikan nilai ID aplikasi (klien) dan ID direktori (penyewa) dalam pendaftaran aplikasi dan URL runtime pusat API. Kemudian, siapkan koneksi ke pusat API lagi.

Konten terkait

• Membangun dan mendaftarkan API dengan ekstensi Azure API Center untuk Visual Studio Code

• Praktik terbaik untuk Azure RBAC

• Mendaftarkan penyedia sumber daya