Visual Studio Code'da Azure API Management ilkeleri oluşturma, anlama ve hatalarını ayıklama

UYGULANANLAR: Tüm API Management katmanları

Bu makalede API Management ilkeleri oluşturmak, anlamak ve hatalarını ayıklamak için Visual Studio Code için Azure API Management Uzantısının nasıl kullanılacağı açıklanmaktadır. Uzantı, ilkelerin hazırlanmasına ve açıklanmasına yardımcı olmak için GitHub Copilot for Azure ile entegre olur.

Azure API Management policy, API istek ve yanıtlarına uygulanan çapraz kesme kaygılarını ele alan bir politika dizisidir. Bu sorunlar arasında kimlik doğrulama, yetkilendirme, hız sınırlama, önbelleğe alma ve dönüştürme yer alır.

Prerequisites

Kısıtlamalar ve sınırlamalar

  • İlke hata ayıklama şu anda yalnızca API Management Geliştirici katmanında desteklenmektedir.

  • İlke hata ayıklaması, görüntüleme adı Yerleşik tüm erişimli abonelik olan yerleşik (hizmet düzeyi) tüm erişimli aboneliği kullanır. Bu aboneliği kullanmak için hizmet sahibi olmanız gerekir.

Azure için GitHub Copilot kullanarak ilke oluşturma

Azure API Management uzantısı, ilke taslağı oluşturmanıza yardımcı olmak için Azure için GitHub Copilot ile tümleşir. Yapay zeka yardımıyla ilkeleri kullanıcı dostu bir şekilde oluşturun ve düzenleyin.

İlke oluşturmak için:

  1. API Management uzantısını Visual Studio Code'da açın.

  2. Çalışmak istediğiniz API Management örneğini seçin.

  3. Çalışmak istediğiniz ilke kapsamını seçin.

    • Örnekteki tüm API'ler için geçerli olan bir ilke oluşturmak için Genel İlke'yi seçin.
    • Belirli bir API'ye uygulanan bir ilke oluşturmak için API'ler'in altında API'yi seçin ve ardından İlke'yi seçin.
    • Belirli bir API işlemine uygulanacak bir ilke oluşturmak için işlemi seçin ve ardından İlke'yi seçin.

  4. Sohbet'i açın.

  5. Sohbet penceresinde, ilke oluşturmak için doğal dilde bir istem girin. Examples:

    @azure I want to limit requests to 100 calls per minute

    @azure Create a policy that sets the backend URL to https://mybackend.contoso.com and adds a custom header to the request

    Copilot, Sohbet penceresinde bir ilke taslağı oluşturur. Copilot'un çıkışını değiştirmesini istiyorsanız istemi düzenleyebilirsiniz.

  6. Hazır olduğunuzda, ilkeyi panoya kopyalamak için Kopyala düğmesini seçin veya düzenleyici penceresine ilkeyi eklemek için Düzenleyici'de Uygula'yı seçin. İlke XML'sindeki değişiklikle memnunsanız Koru'ya tıklayın.

Tip

İlke XML'sindeki sorunların açıklaması için Sorunlar penceresine bakın.

Azure için GitHub Copilot kullanarak ilkeyi açıklama

Copilot, API Management örneğinizdeki mevcut bir ilkeyi açıklamaya yardımcı olabilir.

Açıklama almak için:

  1. API Management uzantısını Visual Studio Code'da açın.

  2. Çalışmak istediğiniz API Management örneğini seçin.

  3. Çalışmak istediğiniz ilke kapsamını seçin.

    • Örnekteki tüm API'ler için geçerli olan bir ilkeyi açıklamak için Genel İlke'yi seçin.
    • Belirli bir API'ye uygulanan bir ilkeyi açıklamak için API'lerin altında API'yi seçin ve ardından İlke'yi seçin.
    • Belirli bir API işlemine uygulanan bir ilkeyi açıklamak için işlemi seçin ve ardından İlke'yi seçin.

  4. Görüntülenen ilke düzenleyicisi penceresinde sağ tıklayın ve ardından Açıkla'yı seçin.

  5. İlke XML belgesindeki ilkelerin genel bakışı ve açıklaması Sohbet penceresinde oluşturulur.

VS Code uzantısını kullanarak ilkelerde hata ayıklama

Visual Studio Code için Azure API Management uzantısı, ağ geçidine istek gönderdiğinizde ilke işlem hattında adım adım ilerleyerek veya kesme noktası ayarlamanıza olanak tanıyan bir hata ayıklama deneyimi sağlar.

Hata ayıklama oturumu başlatma

  1. API Management uzantısını Visual Studio Code'da açın.
  2. Hata ayıklamak için API Management örneğini seçin.
  3. Hata ayıklamak için API'yi ve işlemi seçin.
  4. İşlem üzerine sağ tıklayın ve Politika Hata Ayıklamayı Başlat seçin.

Uzantı, API Management ağ geçidiyle bir hata ayıklama oturumu oluşturmaya başlar. Hata Ayıklama Konsolu penceresinde ilerleme durumunu denetleyin.

Visual Studio Code'da ilke hata ayıklama oturumu başlatılmasının ekran görüntüsü.

Uyarı

Hata ayıklama oturumu başlatmak, sorunları tanılamanıza ve çözmenize yardımcı olmak için oturum sırasında istek izlemeyi de etkinleştirir.

Test isteği gönderme

Hata ayıklama oturumu oluşturulduğunda REST İstemcisi uzantısı, ağ geçidine test HTTP isteği oluşturmanıza ve göndermenize olanak tanıyan yeni bir düzenleyici açar.

Ocp-Apim-Debug üst bilgisi isteğe otomatik olarak eklenir. Bu başlık gereklidir ve API Management ağ geçidinde hata ayıklama işlevini tetiklemek için değerin, tüm erişime sahip hizmet düzeyi abonelik anahtarına ayarlanması gerekir.

Düzenleyicideki HTTP isteğini test senaryonuza göre değiştirin. Ardından test isteğini API Management ağ geçidine göndermek için İstek Gönder'i seçin.

Visual Studio Code'da test isteği gönderme ekran görüntüsü.

Hata ayıklama ilkeleri

Test HTTP isteği gönderildikten sonra uzantı, bu işlemin etkili ilkelerini gösteren hata ayıklama penceresini açar ve ilk etkili ilkede durur.

Visual Studio Code'deki hata ayıklama penceresi ekran görüntüsü.

İlke işlem hattını izlemek için tek tek ilkeler arasında tek adım ilerleyebilir veya ilkede bir kesme noktası ayarlayabilir ve doğrudan bu ilkeye adım atabilirsiniz.

  • Değişkenler panelinde, sistem tarafından oluşturulan ve kullanıcı tarafından oluşturulan değişkenlerin değerlerini inceleyin.
  • Kesme Noktaları panelinde, ayarladığınız tüm kesme noktalarının listesini görüntüleyin.
  • Çağrı Yığını panelinde geçerli ilke kapsamını görüntüleyin.

İlke yürütme sırasında bir hata varsa, hatanın ayrıntılarını oluştuğu ilkede görürsünüz.

Hata ayıklama oturumundan çıkmak için Durdur'u seçin.

Visual Studio Code'daki politika istisnasının ekran görüntüsü.

İpucu

İstek izlemesini gözden geçirmek için, HTTP yanıtında sağlanan Ocp-Apim-Trace-Location başlığının değerini seçin.

İlgili içerik

  • Last updated on