Aracılığıyla paylaş

Azure Container App'i API olarak içeri aktarma

  • Makale

UYGULANANLAR: Tüm API Management katmanları

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

  • Web API'sini kullanıma sunan kapsayıcı uygulamasını içeri aktarma
  • Azure portalında API’yi test etme

Api Management ile Kapsayıcı Uygulamasını Kullanıma Sunma

Azure Container Apps , karmaşık altyapıyı yönetmeden kapsayıcılı uygulamalar dağıtmanıza olanak tanır. API geliştiricileri tercih ettikleri programlama dilini veya çerçevesini kullanarak kod yazabilir, Dağıtılmış Uygulama Çalışma Zamanı (Dapr) için tam destekle mikro hizmetler oluşturabilir ve HTTP trafiğine veya diğer olaylara göre ölçeklendirilebilir.

API Management, kapsayıcı uygulaması tarafından barındırılan bir web API'sini çeşitli nedenlerle kullanıma sunmanın önerilen ortamıdır:

  • API tüketicilerinin arka uç web API'sini yönetmesini ve izlemesini ön ucu yönetme ve güvenliğini sağlamayı ayırma
  • Diğer API'lerinizle aynı ortamda Container 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 belirtimi ile joker karakter işlemleri karşılaştırması

API Management, OpenAPI belirtimi (Swagger tanımı) sağlayan Container Apps'in içeri aktarılmasını destekler. Ancak, OpenAPI belirtimi gerekli değildir. OpenAPI belirtimi sağlamanızı öneririz. API Management tek tek işlemleri içeri aktararak her işlem için yapılandırmaları ayrı ayrı doğrulamanıza, yönetmenize, güvenlik altına almanıza ve güncelleştirmenize olanak tanır.

Kapsayıcı Uygulaması bir OpenAPI belirtimini kullanıma sunarsa, API Management doğrudan tanıma eşleyen API işlemleri oluşturur. API Management, OpenAPI Belirtimi için çeşitli konumlarda arama yapacaktır

  • Container App yapılandırması.
  • /openapi.json
  • /openapi.yml
  • /swagger/v1/swagger.json

OpenAPI belirtimi sağlanmazsa, API Management yaygın HTTP fiilleri (GET, PUT vb.) için joker karakter işlemleri oluşturur. Yine de aynı API Management özelliklerinden yararlanabilirsiniz, ancak işlemler aynı ayrıntı düzeyinde tanımlanmamıştır.

Her iki durumda da, içeri aktarma işleminden sonra API'ye işlemleri düzenleyebilir veya ekleyebilirsiniz.

Örnek

Arka uç Kapsayıcı Uygulamanız iki GET işlemini destekleyebilir:

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

Kapsayıcı Uygulamasını gibi https://contosoapi.azure-api.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.azure-api.net/store/customer/1

GET https://contosoapi.azure-api.net/store/customers
Joker karakter GET /* GET https://contosoapi.azure-api.net/store/customer/1

GET https://contosoapi.azure-api.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

API Management örneğinize gidin

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

    API Management hizmetlerini seçme

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

    API Management örneğinizi seçin

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

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

  2. Listeden Kapsayıcı Uygulaması'nı seçin.

    Kapsayıcı Uygulamasından oluşturma

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

  4. Bir Kapsayıcı Uygulaması seçin. Seçili Kapsayıcı 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. Bu API Management örneğinde benzersiz olmalıdır.

  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.

    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. API Management örneğini oluşturduysanız yönetici olursunuz ve varsayılan olarak her ürüne abone olursunuz.

    Her API Management örneği, oluşturulduğunda iki örnek ürünle 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.

    Kapsayıcı Uygulamasından API oluşturma

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. Üst bilgilerden biri, Ocp-Apim-Subscription-Keybu API ile ilişkili ürünün abonelik anahtarı için şeklindedir. 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.

    Joker karakter işlemini test et

  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.

    Azure API Mgmt örneğine gidin

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

    Özel API'ler

  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.

    İçe aktar'ı seçin

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

    Hizmet seç

Sonraki adımlar

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