Mengaktifkan CORS untuk konsol interaktif di portal pengembang API Management

  • Artikel

Berbagi sumber daya lintas asal (CORS) adalah mekanisme berbasis header HTTP yang memungkinkan server menunjukkan asal apa pun (domain, skema, atau port) selain miliknya sendiri di mana browser harus mengizinkan pemuatan sumber daya.

Untuk memungkinkan pengunjung ke portal pengembang API Management menggunakan konsol pengujian interaktif di halaman referensi API, aktifkan kebijakan CORS untuk API di instans API Management Anda. Jika nama domain portal pengembang bukan asal yang diizinkan untuk permintaan API lintas domain, pengguna konsol pengujian akan melihat kesalahan CORS.

Untuk skenario tertentu, Anda dapat mengonfigurasi portal pengembang sebagai proksi CORS alih-alih mengaktifkan kebijakan CORS untuk API.

BERLAKU UNTUK: Pengembang | Dasar | Standar | Premium

Prasyarat

Membuka instans API Management Anda

  1. Di portal Microsoft Azure, cari dan pilih layanan API Management.

    Pilih layanan API Management

  2. Di halaman layanan API Management, pilih instans API Management Anda.

    Pilih instans API Management Anda

Mengaktifkan kebijakan CORS untuk API

Anda dapat mengaktifkan pengaturan untuk mengonfigurasi kebijakan CORS secara otomatis untuk semua API di instans API Management Anda. Anda juga dapat mengonfigurasi kebijakan CORS secara manual.

Catatan

Hanya satu kebijakan CORS yang dijalankan. Jika Anda menentukan beberapa kebijakan CORS (misalnya, pada tingkat API dan pada tingkat semua API), konsol interaktif Anda mungkin tidak berfungsi seperti yang diharapkan.

Mengaktifkan kebijakan CORS secara otomatis

  1. Di menu kiri instans API Management Anda, di bawah Portal pengembang, pilih Gambaran umum portal.
  2. Di bawah Aktifkan CORS, status konfigurasi kebijakan CORS ditampilkan. Kotak peringatan menunjukkan kebijakan yang tidak ada atau salah dikonfigurasi.
  3. Untuk mengaktifkan CORS dari portal pengembang untuk semua API, pilih Aktifkan CORS.

Cuplikan layar yang memperlihatkan tempat memeriksa status kebijakan CORS Anda di portal pengembang.

Mengaktifkan kebijakan CORS secara manual

  1. Pilih tautan Terapkan secara manual di tingkat global untuk melihat kode kebijakan yang dihasilkan.
  2. Navigasi ke Semua API di bagian API instans API Management Anda.
  3. Pilih ikon </> di bagian Pemrosesan masuk.
  4. Di editor kebijakan, sisipkan kebijakan di bagian <masuk> file XML. Pastikan nilai <asal> cocok dengan domain portal pengembang Anda.

Catatan

Jika Anda menerapkan kebijakan CORS di lingkup Produk, bukan cakupan API, dan API Anda menggunakan autentikasi kunci langganan melalui header, konsol Anda tidak akan berfungsi.

Browser secara otomatis mengeluarkan sebuah permintaan HTTP OPTIONS, yang tidak berisi header dengan kunci langganan. Karena kunci langganan tidak ada, API Management tidak dapat mengaitkan panggilan OPTIONS dengan Produk, sehingga tidak dapat menerapkan kebijakan CORS.

Sebagai solusinya, Anda bisa meneruskan kunci langganan dalam parameter kueri.

Opsi proksi CORS

Untuk beberapa skenario (misalnya, jika gateway API Management terisolasi jaringan), Anda dapat memilih untuk mengonfigurasi portal pengembang sebagai proksi CORS itu sendiri, alih-alih mengaktifkan kebijakan CORS untuk API Anda. Proksi CORS merutekan panggilan API konsol interaktif melalui backend portal di instans API Management Anda.

Catatan

Jika API diekspos melalui gateway yang dihost sendiri atau layanan Anda berada di jaringan virtual, konektivitas dari layanan backend portal pengembang API Management ke gateway diperlukan.

Untuk mengonfigurasi proksi CORS, akses portal pengembang sebagai administrator:

  1. Pada halaman Gambaran Umum instans API Management Anda, pilih Portal pengembang. Portal pengembang terbuka di tab browser baru.
  2. Di menu sebelah kiri antarmuka administratif, pilih Detail API>Halaman.>
  3. Pada halaman API: Detail , pilih widget Operasi: Detail , dan pilih Edit widget.
  4. Pilih Gunakan proksi CORS.
  5. Simpan perubahan ke portal, dan terbitkan ulang portal.

Konfigurasi CORS untuk portal pengembang yang dihost sendiri

Jika Anda menghost sendiri portal pengembang, konfigurasi berikut diperlukan untuk mengaktifkan CORS:

  • Tentukan titik akhir backend portal menggunakan backendUrl opsi dalam file konfigurasi. Jika tidak, portal yang dihost sendiri tidak mengetahui lokasi layanan backend.

  • Tambahkan nilai domain Asal ke konfigurasi portal yang dihost sendiri yang menentukan lingkungan tempat portal yang dihost sendiri dihosting. Pelajari lebih lanjut

Konten terkait