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

bu öğreticide, API Management ortak işlemler için Visual Studio Code API Management uzantısının nasıl kullanılacağını öğrenirsiniz. apı 'leri içeri aktarmak, güncelleştirmek, test etmek ve yönetmek için tanıdık Visual Studio Code ortamını kullanın.

Aşağıdakileri nasıl yapacağınızı öğrenirsiniz:

Ek API Management özelliklerine giriş için Azure Portalkullanarak API Management öğreticileri inceleyin.

Önkoşullar

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

Bir API’yi içeri aktarma

Aşağıdaki örnek, JSON biçiminde bir Openapı belirtimini API Management içine aktarır. Microsoft, bu örnekte kullanılan arka uç API 'sini sağlar ve ' ı Azure 'da barındırır https://conferenceapi.azurewebsites.net?format=json .

1. Visual Studio Code, etkinlik çubuğundan Azure simgesini seçin.
2. Gezgin bölmesinde, oluşturduğunuz API Management örneğini genişletin.
3. API 'ler' e sağ tıklayın ve Openapı bağlantısından içeri aktar' ı seçin.
4. İstendiğinde, aşağıdaki değerleri girin:
   1. JSON biçimindeki içerik için bir Openapı bağlantısı . Bu örnek için: https://conferenceapi.azurewebsites.net?format=json . Bu URL, örnek API 'yi uygulayan hizmettir. İstekleri bu adrese iletir API Management.
   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 karakterlerin alfasayısal olması gerekir. Bu ad, API 'YI çağırmak için yol içinde kullanılır.

API başarıyla alındıktan sonra gezgin bölmesinde görünür ve kullanılabilir API işlemleri, işlemler düğümünün altında görünür.

API 'YI düzenleme

Visual Studio Code ' de API 'YI düzenleyebilirsiniz. Örneğin, API 'ye erişmek için kullanılan http protokolünü kaldırmak için DÜZENLEYICI penceresindeki apı 'nın Kaynak Yöneticisi JSON açıklamasını düzenleyin. Sonra Dosya > Kaydet' i seçin.

Openapı biçimini düzenlemek için, Gezgin bölmesinde API adına sağ tıklayın ve Openapı '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, bir API isteği veya yanıtı üzerinde sırayla yürütülen deyimlerin bir koleksiyonudur. İlkeler, API Management örneğindeki tüm API 'Ler için uygulanan genel olabilir veya belirli bir API veya API işlemi kapsamına eklenebilir.

Bu bölümde API yanıtını dönüştüren API 'nize bazı ortak giden ilkelerin nasıl uygulanacağı gösterilmektedir. Bu örnekteki ilkeler yanıt üst bilgilerini değiştirir ve yanıt gövdesinde görüntülenen özgün arka uç URL 'Lerini gizler.

1. Gezgin bölmesinde, içeri aktardığınız demo-Conference-API altında ilke ' 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ır.

2. Dosyayı öğ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, tanıtım amacıyla özel bir yanıt üst bilgisi ekler.
   • İkinci ilke, varsa set-header X destekli üstbilgiyi siler. Bu üstbilgi, API arka ucunda kullanılan uygulama çerçevesini açığa çıkarabilirsiniz ve yayımcılar genellikle kaldırır.
   • redirect-content-urlsAPI Management ağ geçidi aracılığıyla eşdeğer bağlantılara işaret ettikleri şekilde, yanıt gövdesindeki ilke yeniden yazar (maskeler) bağlantıları.

3. Dosyayı kaydedin. istenirse, dosyayı buluta yüklemek için Upload ' yi seçin.

API’yi test etme

Abonelik anahtarını al

İçeri aktardığınız iç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.

   

API işlemini test etme

1. Gezgin bölmesinde, içeri aktardığınız demo-Conference-API altındaki işlemler düğümünü genişletin.
2. Gethoparlörler gibi bir işlem seçin ve ardından işlemi sağ tıklatın ve test işlemi' ni seçin.
3. Düzenleyici penceresinde, OCP-apim-Subscription-Key' ın yanındaki {{SubscriptionKey}} kopyaladığınız abonelik anahtarıyla değiştirin.
4. İstek gönder’i seçin.

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

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

• Özel üst bilgi yanıta eklenir.
• X Ile güçlendirilmiştir üst bilgi yanıtta görünmez.
• Bu durumda, API arka ucunun URL 'Leri API Management ağ geçidine yönlendirilir https://apim-hello-world.azure-api.net/demo-conference-api .

API işlemini izleme

API işleminde hata ayıklamanıza yardımcı olacak ayrıntılı izleme bilgileri için, OCP-APIM-Trace-location' ın yanında görüntülenen bağlantıyı seçin.

Bu konumdaki JSON dosyası, istek yapıldıktan sonra herhangi bir sorunun nerede olduğunu belirleyebilmeniz için gelen, arka uç ve giden izleme bilgilerini içerir.

Kaynakları temizleme

Artık gerekli değilse, 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).

Sonraki adımlar

bu öğretici, apı 'leri içeri ve yönetmek için kullanabileceğiniz Visual Studio Code için API Management uzantısının çeşitli özelliklerini sunmuştur. Şunları öğrendiniz:

API Management uzantısı, API 'lerinizle çalışmak için ek özellikler sağlar. Örneğin, (Geliştirici hizmet katmanında kullanılabilir) ilkeler hata ayıklama veya adlandırılmış değerlerioluşturma ve yönetme.