Tutorial: Menggunakan ekstensi Azure API Management untuk Visual Studio Code untuk mengimpor dan mengelola API

BERLAKU UNTUK: Konsumsi | Pengembang | Dasar | Standar | Premi

Dalam tutorial ini, Anda mempelajari cara menggunakan ekstensi API Management untuk Visual Studio Code untuk operasi umum di API Management. Gunakan lingkungan Visual Studio Code yang sudah tak asing lagi untuk mengimpor, memperbarui, menguji, dan mengelola API.

Anda akan mempelajari cara untuk:

Untuk pengenalan fitur API Management lainnya, lihat tutorial API Management menggunakan portal Azure.

Prasyarat

• Memahami terminologi Azure API Management.
• Pastikan Anda telah menginstal Visual Studio Code dan ekstensi Azure API Management terbaru untuk Visual Studio Code.
• Membuat instans Azure API Management.

Mengimpor API

Contoh berikut mengimpor Spesifikasi OpenAPI dalam format JSON ke dalam API Management. Untuk contoh ini, Anda mengimpor API Petstore sumber terbuka.

1. Di Visual Studio Code, pilih ikon Azure dari Bilah Aktivitas.
2. Di panel Explorer, perluas instans API Management yang Anda buat.
3. Klik kanan API,dan pilih Impor dari Tautan OpenAPI.
4. Saat diminta, masukkan nilai berikut:

   1. Tautan OpenAPI untuk konten dalam format JSON. Untuk contoh ini: https://petstore.swagger.io/v2/swagger.json.

      File ini menentukan layanan backend yang mengimplementasikan api contoh dan operasi yang didukungnya.

   2. Nama API, seperti petstore, yang unik dalam instans API Management. Nama ini hanya boleh terdiri dari huruf, angka, dan tanda hubung. Karakter pertama dan terakhir harus alfanumerik. Nama ini digunakan dalam jalur untuk memanggil API.

Setelah API berhasil diimpor, API akan muncul di panel Explorer, dan operasi API yang tersedia muncul di bawah node Operasi.

Menyunting API

Anda dapat mengedit API di Visual Studio Code. Misalnya, edit deskripsi JSON Resource Manager dari API di jendela editor untuk menghapus protokol http yang digunakan untuk mengakses API, yang disorot dalam cuplikan berikut:

Untuk mengedit format OpenAPI, klik kanan nama API di panel Explorer dan pilih Edit OpenAPI. Buat perubahan Anda, lalu pilih File>Simpan.

Menerapkan kebijakan ke API

API Management menyediakan kebijakan yang dapat Anda konfigurasi untuk API Anda. Kebijakan adalah kumpulan pernyataan. Pernyataan ini dijalankan secara berurutan berdasarkan permintaan atau respons API. Kebijakan dapat bersifat global, yaitu berlaku untuk semua API dalam instans API Management Anda, atau bersifat khusus untuk suatu produk, API, atau operasi API.

Bagian ini menunjukkan cara menerapkan kebijakan masuk dan keluar umum ke API Anda.

1. Di panel Explorer, pilih Kebijakan di bawah API petstore yang Anda impor. File kebijakan terbuka di jendela editor. File ini mengkonfigurasi kebijakan untuk semua operasi di API.

2. Perbarui file dengan konten berikut:

   <policies>
       <inbound>
           <rate-limit calls="3" renewal-period="15" />
           <base />
       </inbound>
       <outbound>
           <set-header name="Custom" exists-action="override">
               <value>"My custom value"</value>
             </set-header>
           <base />
       </outbound>
       <on-error>
           <base />
       </on-error>
   </policies>
   

   • Kebijakan rate-limit di bagian inbound membatasi jumlah panggilan ke API menjadi 3 setiap 15 detik.
   • Kebijakan set-header di bagian outbound menambahkan header respons kustom untuk tujuan demonstrasi.

3. Simpan file. Jika diminta, pilih Unggah untuk mengunggah file ke cloud.

Menguji API

Untuk menguji API, dapatkan kunci langganan lalu buat permintaan ke gateway API Management.

Mendapatkan kunci berlangganan

Anda memerlukan kunci langganan untuk instans API Management Anda agar dapat menguji API yang diimpor dan kebijakan yang diterapkan.

1. Di panel Explorer, klik kanan nama instans API Management Anda.

2. Pilih Salin Kunci Berlangganan. Kunci ini adalah untuk semua langganan akses bawaan yang dibuat saat Anda membuat instans API Management.

   

   Perhatian

   Langganan semua akses memungkinkan akses ke setiap API dalam instans API Management ini dan hanya boleh digunakan oleh pengguna yang berwenang. Jangan pernah menggunakannya untuk akses API rutin atau sematkan kunci semua akses di aplikasi klien.

Menguji operasi API

1. Di panel Explorer, perluas simpul Operasi di bawah API petstore yang Anda impor.
2. Pilih operasi seperti [GET] Temukan hewan peliharaan berdasarkan ID, lalu klik kanan operasi dan pilih Operasi Pengujian.
3. Di jendela editor, ganti 5petId parameter di URL permintaan.
4. Di jendela editor, di samping Ocp-Apim-Subscription-Key, tempelkan kunci langganan yang Anda salin.
5. Pilih Kirim Permintaan.

Ketika permintaan berhasil, backend akan merespons dengan 200 OK dan beberapa data.

Perhatikan detail berikut dalam respons:

• Header Custom ditambahkan ke respons.

Sekarang uji kebijakan pembatasan tarif. Pilih Kirim permintaan beberapa kali berturut-turut. Setelah mengirim terlalu banyak permintaan dalam periode yang dikonfigurasi, Anda mendapatkan 429 Too Many Requests respons.

Melacak pemrosesan permintaan

Secara opsional, Anda bisa mendapatkan informasi pelacakan permintaan terperinci untuk membantu Anda men-debug dan memecahkan masalah API.

Untuk langkah-langkah mengaktifkan pelacakan untuk API, lihat Mengaktifkan pelacakan untuk API. Untuk membatasi pengungkapan informasi sensitif yang tidak diinginkan, pelacakan secara default hanya diizinkan selama 1 jam.

Membersihkan sumber daya

Saat tidak lagi diperlukan, hapus instans API Management dengan mengklik kanan dan memilih Buka di Portal untuk menghapus layanan API Management dan grup sumber dayanya.

Atau, Anda dapat memilih Hapus API Management untuk hanya menghapus instans API Management (operasi ini tidak akan menghapus grup sumber dayanya).

Konten terkait

Tutorial ini memperkenalkan beberapa fitur ekstensi API Management untuk Visual Studio Code. Anda dapat menggunakan fitur ini untuk mengimpor dan mengelola API. Anda mempelajari cara untuk:

Ekstensi API Management menyediakan lebih banyak fitur untuk bekerja dengan API Anda. Misalnya, debug kebijakan (tersedia di tingkat layanan Pengembang), atau membuat dan mengelola nilai yang bernama.