API Management geliştirici portalında etkileşimli konsol için CORS'yi etkinleştirme

ŞUNLAR IÇIN GEÇERLIDIR: Geliştirici | Temel | Temel v2 | Standart | Standart v2 | Premium | Premium v2

Çıkış noktaları arası kaynak paylaşımı (CORS), bir sunucunun, tarayıcının kaynakları yüklemeye izin vermesi gereken kendi kaynağı (etki alanı, şema veya bağlantı noktası) dışında herhangi bir kaynağı (etki alanı, düzen veya bağlantı noktası) belirtmesine olanak tanıyan HTTP üst bilgi tabanlı bir mekanizmadır.

API Management geliştirici portalı ziyaretçilerinin API başvuru sayfalarında etkileşimli test konsolunu kullanmasına izin vermek için API Management örneğinizdeki API'ler için cors ilkesini etkinleştirin. Geliştirici portalının etki alanı adı, etki alanları arası API istekleri için izin verilen bir kaynak değilse, test konsolu kullanıcıları CORS hatası görür.

Belirli senaryolarda, API'ler için CORS ilkesini etkinleştirmek yerine geliştirici portalını CORS proxy'si olarak yapılandırabilirsiniz.

Önkoşullar

• Şu hızlı başlangıcı tamamlayın: Azure API Management örneği oluşturma

API Management örneğinize gidin

1. Azureportalında API Management hizmetleriniarayıp seçin:

   

2. API Management hizmetleri sayfasında API Management örneğinizi seçin:

   

API'ler için CORS ilkesini etkinleştirme

API Management örneğinizdeki tüm API'ler için bir CORS ilkesini otomatik olarak yapılandırma ayarını etkinleştirebilirsiniz. CorS ilkesini el ile de yapılandırabilirsiniz.

Uyarı

Yalnızca bir CORS ilkesi yürütülür. Birden çok CORS ilkesi belirtirseniz (örneğin, API düzeyinde ve tüm API'ler düzeyinde), etkileşimli konsolunuz beklendiği gibi çalışmayabilir.

CORS ilkesini otomatik olarak etkinleştirme

1. API Management örneğinizin sol menüsünde, Geliştirici portalı'nın altında Portala genel bakış'ı seçin.
2. CORS'yi etkinleştir altında, CORS ilke yapılandırmasının durumu görüntülenir. Uyarı kutusu, eksik veya yanlış yapılandırılmış bir ilkeyi gösterir.
3. Tüm API'ler için geliştirici portalından CORS'yi etkinleştirmek için CORS'yi etkinleştir'i seçin.

CORS ilkesini el ile etkinleştirme

1. Oluşturulan ilke kodunu görmek için Genel düzeyde el ile uygula bağlantısını seçin.
2. API Management örneğinizin API'ler bölümünde Tüm API'ler'e gidin.
3. < bölümünde /> simgesini seçin.
4. İlke düzenleyicisinde, ilkeyi XML dosyasının <gelen> bölümüne ekleyin. Kaynak< değerinin> geliştirici portalınızın etki alanıyla eşleştiğinden emin olun.

Uyarı

CORS ilkesini API'ler kapsamı yerine Ürün kapsamına uygularsanız ve API'niz üst bilgi aracılığıyla abonelik anahtarı kimlik doğrulamasını kullanırsa konsolunuz çalışmaz.

Tarayıcı otomatik olarak abonelik anahtarıyla üst bilgi içermeyen bir OPTIONS HTTP isteği oluşturur. Eksik abonelik anahtarı nedeniyle API Management çağrıyı OPTIONS bir Ürünle ilişkilendiremediğinden CORS ilkesini uygulayamaz.

Geçici bir çözüm olarak abonelik anahtarını bir sorgu parametresine geçirebilirsiniz.

Özelleştirilmiş alan adı için CORS yapılandırması

Geliştirici portalı için özel bir etki alanı yapılandırıyorsanız ve ziyaretçilerin API başvuru sayfalarında test konsolunu kullanmasını istiyorsanız, özel geliştirici portalı etki alanı adı için CORS'yi etkinleştirdiğinizden emin olun.

Özel etki alanını yapılandırırken, CORS ilkesinde özel geliştirici portalı etki alanınız için kaynak ekleme ayarını etkinleştirebilirsiniz. CORS varsayılan etki alanı için zaten etkinleştirildiyse, her iki kaynak da CORS ilkesine eklenir. CORS ilke ayarlarını istediğiniz zaman değiştirebilirsiniz.

CORS proxy seçeneği

Bazı senaryolarda (örneğin, API Management ağ geçidi ağdan yalıtılmışsa), API'leriniz için bir CORS ilkesini etkinleştirmek yerine geliştirici portalını CORS proxy'si olarak yapılandırmayı seçebilirsiniz. CORS ara sunucusu, api management örneğinizdeki portalın arka ucu aracılığıyla etkileşimli konsolun API çağrılarını yönlendirir.

Uyarı

API'ler şirket içinde barındırılan bir ağ geçidi aracılığıyla kullanıma sunulduysa veya hizmetiniz bir sanal ağdaysa, API Management geliştirici portalının arka uç hizmetinden ağ geçidine bağlantı gereklidir.

CORS proxy'sini yapılandırmak için geliştirici portalına yönetici olarak erişin:

1. API Management örneğinizin Genel Bakış sayfasında Geliştirici portalı'nı seçin. Geliştirici portalı yeni bir tarayıcı sekmesinde açılır.
2. Yönetim arabiriminin sol menüsünde Sayfa>API'leri>Ayrıntıları'nı seçin.
3. API'ler: Ayrıntılar sayfasında İşlem: Ayrıntılar pencere öğesini ve ardından Pencere öğesini düzenle'yi seçin.
4. CORS ara sunucusunu kullan'ı seçin.
5. Değişiklikleri portala kaydedin ve portalı yeniden yayımlayın.

Yerel olarak barındırılan geliştirici portalı için CORS yapılandırması

Geliştirici portalını kendi kendine barındırıyorsanız , CORS'yi etkinleştirmek için aşağıdaki yapılandırma gerekir:

• Yapılandırma dosyalarındaki backendUrl seçeneğini kullanarak portalın arka uç uç noktasını belirtin. Aksi takdirde, kendi kendini barındıran portal, arka uç hizmetinin konumunun farkında değildir.

• Kendinden barındırılan portalın barındırıldığı ortamları belirten kendinden barındırılan portal yapılandırmasına Origin etki alanı değerleri ekleyin. Daha fazla bilgi edinin

İlgili içerik

• İlke yapılandırma hakkında daha fazla bilgi için bkz. İlkeleri ayarlama veya düzenleme.
• CORS ilkesi hakkında ayrıntılı bilgi için cors ilke başvurusuna bakın.