Kebijakan Debug Azure API Management di Visual Studio Code
BERLAKU UNTUK: Pengembang
Kebijakan dalam Azure API Management memberikan kemampuan canggih yang membantu penerbit API mengatasi masalah lintas pemotongan seperti autentikasi, otorisasi, throttling, pembuatan cache, dan transformasi. Kebijakan adalah kumpulan pernyataan yang dijalankan secara berurutan atas permintaan atau respons API.
Artikel ini menjelaskan cara untuk mendebug kebijakan API Management menggunakan Azure API Management Extension for Visual Studio Code.
Prasyarat
Buat instans tingkat Pengembang API Management dengan mengikuti mulai cepat ini terlebih dahulu.
Instal Visual Studio Code dan versi terbaru Azure API Management Extension for Visual Studio Code.
Impor API ke instance API Management Anda. Untuk contoh langkahnya, lihat Tutorial: Gunakan Ekstensi API Management untuk Visual Studio Code untuk mengimpor dan mengelola API.
Pembatasan dan batasan
- Fitur ini menggunakan langganan semua akses bawaan (tingkat layanan) (nama tampilan "Langganan semua akses bawaan") untuk penelusuran kesalahan.
Penting
- API Management tidak lagi mendukung langganan untuk pelacakan atau header Ocp-Apim-Trace .
- Untuk meningkatkan keamanan API, pelacakan sekarang dapat diaktifkan pada tingkat API individual dengan mendapatkan token terbatas waktu menggunakan API Management REST API, dan meneruskan token dalam permintaan ke gateway. Untuk detailnya, lihat Mengaktifkan pelacakan API.
- Berhati-hatilah saat mengaktifkan pelacakan, karena dapat mengekspos informasi sensitif dalam data pelacakan. Pastikan Anda memiliki langkah-langkah keamanan yang sesuai untuk melindungi data pelacakan.
Memulai sesi debugging
- Luncurkan Visual Studio Code
- Menavigasi ke ekstensi API Management berdasarkan ekstensi Azure
- Temukan instans API Management untuk men-debug
- Temukan API dan operasi untuk debug
- Klik kanan pada operasi dan pilih Mulai debugging kebijakan
Pada titik ini, ekstensi akan mencoba memulai dan membuat sesi debugging dengan gateway API Management.
Mengirim permintaan pengujian
Ketika sesi debugging ditetapkan, ekstensi akan membuka editor baru yang memungkinkan kami untuk membuat dan mengirim permintaan HTTP pengujian ke operasi ini yang memanfaatkan ekstensi Klien REST.
Anda akan melihat header Ocp-Apim-Debug telah ditambahkan ke permintaan. Header ini diperlukan dan nilai harus diatur ke tingkat layanan, kunci langganan semua akses untuk memicu fungsionalitas debugging di gateway API Management.
Ubah permintaan HTTP di editor sesuai dengan skenario pengujian Anda. Kemudian klik kirim permintaan untuk mengirim permintaan pengujian ke gateway API Management.
Kebijakan debug
Setelah permintaan HTTP pengujian dikirim, ekstensi akan membuka jendela debugging yang menunjukkan kebijakan efektif operasi ini dan berhenti pada kebijakan efektif pertama.
Untuk mengikuti alur kebijakan, Anda dapat melangkah tunggal melalui kebijakan individual atau menetapkan titik henti pada kebijakan dan langsung ke kebijakan tersebut.
Di panel Variabel, Anda dapat memeriksa nilai variabel yang dibuat sistem dan dibuat pengguna. Di panel Breakpoints, Anda dapat melihat daftar semua titik henti yang telah ditetapkan. Di panel Call Stack, Anda dapat melihat lingkup kebijakan efektif saat ini.
Jika ada kesalahan selama eksekusi kebijakan, Anda akan melihat detail kesalahan pada kebijakan di mana hal itu terjadi.
Tip
Ingatlah untuk keluar dari sesi debug dengan mengklik tombol Stop ketika Anda selesai.
Langkah berikutnya
- Pelajari selengkapnya tentang ekstensi API Management for Visual Studio Code.
- Melaporkan masalah di repositori GitHub