Azure Web App'i API olarak içeri aktarma

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, Azure portalını kullanarak Azure Web App'i Azure API Management'a aktarma ve içeri aktarılan API'yi test etme adımları gösterilmektedir.

Not

API'lerinizi içeri aktarmak ve yönetmek için Visual Studio Code için API Management Uzantısı'nı kullanabilirsiniz. Yüklemek ve kullanmaya başlamak için API Management Uzantısı öğreticisini izleyin.

Bu makalede şunları öğreneceksiniz:

• App Service'te barındırılan bir Web Uygulamasını içeri aktarma
• Azure portalında API’yi test etme

API Management ile Web Uygulamasını Kullanıma Sunma

Azure Uygulaması Hizmeti web uygulamalarını, REST API'leri ve mobil arka uçları barındırmaya yönelik HTTP tabanlı bir hizmettir. API geliştiricileri API'ler geliştirmek ve API arka uçlarını güvenli, ölçeklenebilir bir ortamda Web Apps olarak yayımlamak için tercih ettikleri teknoloji yığınlarını ve işlem hatlarını kullanabilir. Ardından API Management'ı kullanarak Web Apps'i kullanıma sunun, API'leri yaşam döngüleri boyunca yönetin ve koruyun ve bunları tüketicilere yayımlayın.

API Management, web uygulamasında barındırılan bir API'yi çeşitli nedenlerle kullanıma sunmanın önerilen ortamıdır:

• API tüketicilerine sunulan ön ucun yönetilmesini ve güvenliğini sağlamayı arka uç Web Uygulamasını yönetmek ve izlemekten ayırma
• Diğer API'lerinizle aynı ortamda Web Apps olarak barındırılan web API'lerini yönetme
• Api davranışını değiştirmek için çağrı hızı sınırlama gibi ilkeler uygulama
• API'lerinizi keşfetmek ve öğrenmek, erişim istemek ve denemek için API tüketicilerini API Management'ın özelleştirilebilir geliştirici portalına yönlendirin

Daha fazla bilgi için bkz . API Management hakkında.

OpenAPI tanımı ile joker karakter işlemleri karşılaştırması

API Management, OpenAPI tanımı (Swagger tanımı) içeren App Service'te barındırılan Web Uygulamalarının içeri aktarılmasını destekler. Ancak OpenAPI tanımı gerekli değildir.

• Web Uygulaması bir OpenAPI tanımıyla yapılandırılmışsa, API Management bunu algılar. Alternatif olarak, tanımı API Management'a el ile aktarabilirsiniz. Ardından API Management, gerekli yollar, parametreler ve yanıt türleri dahil olmak üzere doğrudan tanımla eşleyen API işlemleri oluşturur.

  Bir OpenAPI tanımına sahip olmak önerilir, çünkü API yüksek doğrulukla API Management'a aktarılır ve her işlem için yapılandırmaları ayrı ayrı doğrulama, yönetme, güvenlik ve güncelleştirme esnekliği sağlar.

• OpenAPI tanımı sağlanmazsa, API Management yaygın HTTP fiilleri (GET, PUT vb.) için joker karakter işlemleri oluşturur. API isteğini arka uç API'sine geçirmek için, joker karakter işlemine gerekli yolu veya parametreleri ekleyin.

  Joker karakter işlemleriyle aynı API Management özelliklerinden yararlanmaya devam edebilirsiniz, ancak işlemler varsayılan olarak aynı ayrıntı düzeyinde tanımlanmamıştır. Her iki durumda da, içeri aktarılan API'yi düzenleyebilir veya işlemleri ekleyebilirsiniz .

Örnek

Arka uç Web Uygulamanız iki GET işlemi destekleyebilir:

• https://myappservice.azurewebsites.net/customer/{id}
• https://myappservice.azurewebsites.net/customers

Web Uygulamasını gibi https://contosoapi.azureapi.net/storebir yolda API Management hizmetinize aktarırsınız. Aşağıdaki tabloda, OpenAPI belirtimi ile veya olmadan API Management'a aktarılan işlemler gösterilmektedir:

Tür	İçeri aktarılan işlemler	Örnek istekler
OpenAPI belirtimi	GET /customer/{id} GET /customers	GET https://contosoapi.azureapi.net/store/customer/1 GET https://contosoapi.azureapi.net/store/customers
Joker karakter	GET /*	GET https://contosoapi.azureapi.net/store/customer/1 GET https://contosoapi.azureapi.net/store/customers

Joker karakter işlemi, OpenAPI belirtimindeki işlemlerle aynı arka uç hizmetine yönelik isteklere izin verir. Ancak, OpenAPI tarafından belirtilen işlemler API Management'ta ayrı olarak yönetilebilir.

Önkoşullar

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

• Aboneliğinizde bir App Service olduğundan emin olun. Daha fazla bilgi için App Service belgelerine bakın.

  Örnek bir web API'sini oluşturma ve Azure Web App olarak yayımlama adımları için bkz:

  • Öğretici: ASP.NET Core ile web API'si oluşturma
  • Visual Studio Code ile ASP.NET Core uygulamasını Azure'da yayımlama

API Management örneğinize gidin

1. Azure portalında API Management hizmetlerini arayın ve seçin.

   

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

   

Arka uç API’sini içeri aktarma ve yayımlama

İpucu

Aşağıdaki adımlar, Azure portalında Azure API Management'ı kullanarak içeri aktarma işlemini başlatır. Uygulamanın API menüsünden API Management'ı seçerek API Management'a doğrudan Web Uygulamanızdan da bağlanabilirsiniz.

1. Azure portalında API Management hizmetinize gidin ve menüden API'ler'i seçin.

2. Listeden App Service'i seçin.

   

3. Aboneliğinizdeki App Services listesini görmek için Gözat'ı seçin.

4. Bir App Service seçin. Seçili Web Uygulaması ile bir OpenAPI tanımı ilişkilendirildiyse, API Management bunu getirir ve içeri aktarır.

   OpenAPI tanımı bulunmazsa, API Management yaygın HTTP fiilleri için joker karakter işlemleri oluşturarak API'yi kullanıma sunar.

5. API URL'si soneki ekleyin. Sonek, bu belirli API’yi bu API Management örneğinde tanımlayan bir addır. Son ekin bu APIM örneğinde benzersiz olması gerekir.

6. API’yi bir ürünle ilişkilendirerek yayımlayın. Bu durumda, "Sınırsız" ürünü kullanılır. API'nin yayımlanmasını ve geliştiricilerin kullanımına sunulmasını istiyorsanız, api'yi bir ürüne ekleyin. API oluşturması sırasında yapabilir ya da daha sonra ayarlayabilirsiniz.

   Not

   Ürünler bir veya daha fazla API arasındaki ilişkilendirmelerdir. Birçok API ekleyebilir ve bunları geliştirici portalı aracılığıyla geliştiricilere sunabilirsiniz. Geliştiricilerin bir API’ye erişebilmesi için önce ürüne abone olması gerekir. Abone olduklarında, ilgili üründeki tüm API’ler için geçerli olan bir abonelik anahtarı edinirler. APIM örneğini siz oluşturduysanız zaten bir yöneticisinizdir ve varsayılan olarak tüm ürünlere abone olmuşsunuz demektir.

   Varsayılan olarak, her bir API Management örneği iki örnek ürün ile birlikte gelir:

   • Başlangıç
   • Sınırsız

7. Diğer API ayarlarını girin. Oluşturma sırasında değerleri ayarlayabilir veya daha sonra Ayarlar sekmesine giderek bunları yapılandırabilirsiniz. Ayarlar, İlk API'nizi içeri aktarma ve yayımlama öğreticisinde açıklanmıştır.

8. Oluştur'u belirleyin.

Azure portalında yeni API'yi test edin

İşlemler doğrudan bir API’nin işlemlerini görüntülemek ve test etmek için kullanışlı bir yol sağlayan Azure portalından çağrılabilir. Api'yi geliştirici portalında veya kendi REST istemci araçlarınızı kullanarak da test edebilirsiniz.

1. Önceki adımda oluşturduğunuz API’yi seçin.

2. Test sekmesini seçin.

3. Bir işlem seçin.

   Sayfa, sorgu parametrelerinin ve üst bilgilerin alanlarını görüntüler. Bu API ile ilişkilendirilmiş ürünün abonelik anahtarı için, üst bilgilerden biri "Ocp-Apim-Subscription-Key" üst bilgisidir. API Management örneğini siz oluşturduysanız zaten bir yöneticisinizdir ve anahtar otomatik olarak doldurulur.

4. Gönder’e basın.

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

Portalda joker karakter işlemini test edin

Joker karakter işlemleri oluşturulduğunda, işlemler doğrudan arka uç API'sine eşlenmeyebilir. Örneğin, API Management'ta içeri aktarılan joker karakterLI GET işlemi varsayılan olarak yolu / kullanır. Ancak arka uç API'niz aşağıdaki yolda bir GET işlemini destekleyebilir:

/api/TodoItems

Yolu /api/TodoItems aşağıdaki gibi test edebilirsiniz.

1. Oluşturduğunuz API'yi seçin ve işlemi seçin.

2. Test sekmesini seçin.

3. Şablon parametrelerinde joker karakter (*) adının yanındaki değeri güncelleştirin. Örneğin, api/TodoItems adresini girin. Bu değer joker karakter işleminin yoluna / eklenir.

   

4. Gönder'i seçin.

Diğer API'leri ekleme

Farklı hizmetler tarafından kullanıma sunulan API'lerden oluşan bir API oluşturabilirsiniz, örneğin:

• OpenAPI belirtimi
• SOAP API'si
• GraphQL API'si
• Azure Uygulaması Hizmetinde barındırılan bir Web Uygulaması
• Azure İşlev Uygulaması
• Azure Logic Apps
• Azure Service Fabric

Aşağıdaki adımları kullanarak mevcut API'nize farklı bir API ekleyin.

Not

Başka bir API'yi içeri aktardığınızda işlemler geçerli API'nize eklenir.

1. Azure portal'da Azure API Management kurulumunuza gidin.

   

2. Genel Bakış sayfasında veya soldaki menüden API'ler'i seçin.

   

3. Başka bir API eklemek istediğiniz API'nin yanındaki ... simgesine tıklayın.

4. Açılan menüden İçeri aktar'ı seçin.

   

5. API'nin içeri aktarılacağı hizmeti seçin.

   

İlgili konular

• API içeri aktarma sınırlamaları
• OpenAPI belirtimini içeri aktarma
• SOAP API’sini içeri aktarma
• SOAP API'sini içeri aktarma ve REST’e dönüştürme
• App Service API'sini içeri aktarma
• Kapsayıcı Uygulama API'sini içeri aktarma
• WebSocket API'lerini içeri aktarma
• GraphQL API’sini içeri aktarma
• GraphQL şemasını içeri aktarma ve alan çözümleyicilerini ayarlama
• Azure İşlev Uygulamalarını içeri aktarma
• Azure Mantıksal Uygulamalarını içeri aktarma
• Service Fabric hizmetlerini içeri aktarma
• Azure OpenAI API'lerini içeri aktarma
• OData API'sini içeri aktarma
• SAP OData meta verilerini içeri aktarma
• gRPC API'lerini içeri aktarma
• API’yi düzenleme

Sonraki adımlar

Yayımlanan API’yi dönüştürme ve koruma