Öğretici: API'leri içeri aktarmak ve yönetmek için Visual Studio Code için Azure API Management uzantısını kullanma

ŞUNLAR IÇIN GEÇERLIDIR: Tüketim | Geliştirici | Temel | Standart | Premium

Bu öğreticide, API Management'taki yaygın işlemler için Visual Studio Code için API Management uzantısını kullanmayı öğreneceksiniz. API'leri içeri aktarmak, güncelleştirmek, test etmek ve yönetmek için tanıdık Visual Studio Code ortamını kullanın.

Şunları yapmayı öğreneceksiniz:

• API'yi API Management'a aktarma
• API'yi düzenleme
• API Management ilkelerini uygulama
• API’yi test etme

Daha fazla API Management özelliğine giriş için bkz. Azure portalını kullanarak API Management öğreticileri.

Önkoşullar

• Azure API Management terminolojisini anlama.
• Visual Studio Code'u ve Visual Studio Code için en son Azure API Management uzantısını yüklediğinizden emin olun.
• BIR API Management örneği oluşturun.

Bir API’yi içeri aktarma

Aşağıdaki örnek, JSON biçimindeki bir OpenAPI Belirtimini API Management'a aktarır. Microsoft, bu örnekte kullanılan arka uç API'sini sağlar ve azure'da https://conferenceapi.azurewebsites.netbarındırıyor.

1. Visual Studio Code'da Etkinlik Çubuğu'ndan Azure simgesini seçin.
2. Gezgin bölmesinde, oluşturduğunuz API Management örneğini genişletin.
3. API'lere sağ tıklayın ve OpenAPI Bağlantısından İçeri Aktar'ı seçin.
4. İstendiğinde aşağıdaki değerleri girin:

   1. JSON biçiminde içerik için OpenAPI bağlantısı. Bu örnek için: https://conferenceapi.azurewebsites.net?format=json.

      Bu dosya, bu örnekte https://conferenceapi.azurewebsites.netörnek API'yi uygulayan arka uç hizmetini belirtir. API Management istekleri bu web hizmetine iletir.

   2. API Management örneğinde benzersiz olan demo-conference-api gibi bir API adı. Bu ad yalnızca harf, sayı ve kısa çizgi içerebilir. İlk ve son karakterler alfasayısal olmalıdır. Bu ad, API'yi çağırmak için yolda kullanılır.

API başarıyla içeri aktarıldıktan sonra, Gezgin bölmesinde görünür ve kullanılabilir API işlemleri İşlemler düğümü altında görünür.

API'yi düzenleme

API'yi Visual Studio Code'da düzenleyebilirsiniz. Örneğin, API'ye erişmek için kullanılan http protokolünü kaldırmak için düzenleyici penceresinde API'nin Resource Manager JSON açıklamasını düzenleyin.

OpenAPI biçimini düzenlemek için, Gezgin bölmesinde API adına sağ tıklayın ve OpenAPI'yi Düzenle'yi seçin. Değişikliklerinizi yapın ve ardından Dosya>Kaydet'i seçin.

API'ye ilke uygulama

API Management, API'leriniz için yapılandırabileceğiniz ilkeler sağlar. İlkeler, deyimlerden oluşan bir koleksiyonlardır. Bu deyimler, bir API'nin isteği veya yanıtı üzerinde sıralı olarak çalıştırılır. İlkeler, API Management örneğinizdeki tüm API'ler için geçerli olan genel veya bir ürüne, API'ye veya API işlemine özgü olabilir.

Bu bölümde, API yanıtını dönüştüren genel giden ilkelerinin API'nize nasıl uygulanacağı gösterilmektedir. Bu örnekteki ilkeler yanıt üst bilgilerini değiştirir ve yanıt gövdesinde görünen özgün arka uç URL'lerini gizler.

1. Gezgin bölmesinde, içeri aktardığınız demo-conference-api'nin altında İlke'yi seçin. İlke dosyası düzenleyici penceresinde açılır. Bu dosya API'deki tüm işlemler için ilkeleri yapılandırıyor.

2. dosyasını öğesinde aşağıdaki içerikle güncelleştirin <outbound> :

   [...]
   <outbound>
       <set-header name="Custom" exists-action="override">
           <value>"My custom value"</value>
       </set-header>
       <set-header name="X-Powered-By" exists-action="delete" />
       <redirect-content-urls />
       <base />
   </outbound>
   [...]
   

   • İlk set-header ilke, gösterim amacıyla özel bir yanıt üst bilgisi ekler.
   • İkinci set-header ilke, varsa X-Powered-By üst bilgisini siler. Bu üst bilgi, API arka uçta kullanılan uygulama çerçevesini ortaya çıkarabilir ve yayımcılar bunu genellikle kaldırır.
   • İlke, redirect-content-urls API Management ağ geçidi aracılığıyla eşdeğer bağlantılara işaret edebilmeleri için yanıt gövdesindeki bağlantıları yeniden yazar (maskeler).

3. Dosyayı kaydedin. İstenirse karşıya yükle'yi seçerek dosyayı buluta yükleyin.

API’yi test etme

API'yi test etmek için bir abonelik anahtarı alın ve ardından API Management ağ geçidine bir istek gönderin.

Abonelik anahtarını alma

İçeri aktarılan API'yi ve uygulanan ilkeleri test etmek için API Management örneğiniz için bir abonelik anahtarına ihtiyacınız vardır.

1. Gezgin bölmesinde API Management örneğinizin adına sağ tıklayın.

2. Abonelik Anahtarını Kopyala'yı seçin. Bu anahtar, bir API Management örneği oluşturduğunuzda oluşturulan yerleşik tüm erişim aboneliğine yöneliktir.

   

   Dikkat

   Tümü erişimli abonelik, bu API Management örneğindeki her API'ye erişim sağlar ve yalnızca yetkili kullanıcılar tarafından kullanılmalıdır. Bunu hiçbir zaman rutin API erişimi için kullanmayın veya istemci uygulamalarına tüm erişim anahtarını ekleyin.

API işlemini test edin

1. Gezgin bölmesinde, içeri aktardığınız demo-conference-api'nin altındaki İşlemler düğümünü genişletin.
2. GetSpeakers gibi bir işlem seçin ve ardından işleme sağ tıklayıp Test İşlemi'ni seçin.
3. Düzenleyici penceresinde, Ocp-Apim-Subscription-Key öğesinin yanındaki öğesini kopyaladığınız abonelik anahtarıyla değiştirin{{SubscriptionKey}}.
4. İstek gönder’i seçin.

İstek başarılı olduğunda arka uç 200 Tamam ve bazı verilerle yanıt verir.

Yanıtta aşağıdaki ayrıntılara dikkat edin:

• Özel üst bilgisi yanıta eklenir.
• X-Powered-By üst bilgisi yanıtta görünmez.
• API arka ucuna url'ler, bu örnekte https://apim-hello-world.azure-api.net/demo-conference-apiAPI Management ağ geçidine yönlendirilir.

İzleme isteği işleme

İsteğe bağlı olarak, API'de hata ayıklamanıza ve sorun gidermenize yardımcı olmak için ayrıntılı istek izleme bilgilerini alabilirsiniz.

API için izlemeyi etkinleştirme adımları için bkz . API için izlemeyi etkinleştirme. Hassas bilgilerin istenmeyen şekilde açıklanmasını sınırlamak için, varsayılan olarak izlemeye yalnızca 1 saat izin verilir.

Kaynakları temizleme

Artık gerekli olmadığında, API Management hizmetini ve kaynak grubunu silmek için sağ tıklayıp Portalda Aç'ı seçerek API Management örneğini kaldırın.

Alternatif olarak, API Management'ı Sil'i seçerek yalnızca API Management örneğini silebilirsiniz (bu işlem kaynak grubunu silmez).

İlgili içerik

Bu öğreticide Visual Studio Code için API Management uzantısının çeşitli özellikleri tanıtıldı. API'leri içeri aktarmak ve yönetmek için bu özellikleri kullanabilirsiniz. Şunları öğrendiniz:

• API'yi API Management'a aktarma
• API'yi düzenleme
• API Management ilkelerini uygulama
• API’yi test etme

API Management uzantısı, API'lerinizle çalışmak için daha fazla özellik sağlar. Örneğin, hata ayıklama ilkeleri (Geliştirici hizmet katmanında kullanılabilir) veya adlandırılmış değerler oluşturup yönetin.