Azure kapsayıcı uygulamasını API olarak içeri aktarma

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, azure kapsayıcı uygulamasının Azure API Management'a API olarak nasıl aktarıldığı ve Azure portalını kullanarak içeri aktarılan API'nin nasıl test edilir açıklanmaktadır.

Not tutunuz

Şu anda bu özellik çalışma alanlarında kullanılamaz.

Bu makalede şunları öğreneceksiniz:

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

API Management kullanarak 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 dili veya çerçevesiyle 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'ı kullanarak kapsayıcı uygulamasında barındırılan bir web API'sini kullanıma sunarak aşağıdaki avantajları elde edebilirsiniz:

  • API tüketicilerine sunulan ön ucun yönetim ve güvenliğini, arka uç web API'sinin yönetimi ve izlenmesinden ayırın.
  • Diğer API'lerinizle aynı ortamda kapsayıcı uygulamaları olarak barındırılan web API'lerini yönetin.
  • Api davranışını değiştirmek için çağrı hızı sınırlaması gibi ilkeler uygulayın.
  • API tüketicilerini özelleştirilebilir API Management geliştirici portalına yönlendirerek API'lerinizi keşfedip öğrenebilir, erişim isteyebilir ve API'leri deneyebilirler.

Daha fazla bilgi için bkz. Azure API Management nedir?

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

API Management, OpenAPI belirtimi (Swagger tanımı) sağlayan kapsayıcı uygulamalarını içeri aktarmayı destekler. OpenAPI belirtimi gerekli değildir, ancak bir belirtim 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ızı ve güncelleştirmenizi sağlar.

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 arar:

  • Kapsayıcı uygulaması yapılandırması
  • /openapi.json
  • /openapi.yml
  • /swagger/v1/swagger.json

OpenAPI belirtimi sağlanmazsa, API Management sık kullanılan 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 API'yi içeri aktardıktan sonra işlemleri düzenleyebilir veya ekleyebilirsiniz .

Örnek

Arka uç kapsayıcı uygulamanız iki GET işlemini destekleyebilir:

  • https://<app-service>.azurewebsites.net/customer/<id>
  • https://<app-service>.azurewebsites.net/customers

Kapsayıcı uygulamasını, https://<api>.azure-api.net/store gibi bir yolda API Management hizmetinize aktarısınız. Aşağıdaki tabloda, OpenAPI belirtimi ile veya olmadan API Management'a aktarılan işlemler gösterilmektedir:

Tip İçeri aktarılan işlemler Örnek talepler
OpenAPI belirtimi GET /customer/<id>

GET /customers
GET https://<api>.azure-api.net/store/customer/1

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

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

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

  1. Azure portalında API Management hizmetinize gidin.

  2. Kenar çubuğu menüsünde API API'leri'ni> ve ardından + API Ekle'yi seçin.

  3. Azure kaynağından oluştur'un altında Kapsayıcı Uygulaması kutucuğunu seçin:

    Kapsayıcı Uygulaması kutucuğunu gösteren ekran görüntüsü.

  4. Aboneliğinizdeki kapsayıcı uygulamaların listesini görmek için Gözat'ı seçin.

  5. Bir kapsayıcı uygulaması seçin. Seçili kapsayıcı uygulamasıyla 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.

  6. API URL son ekini ekleyin. Sonek, API Management örneğindeki API'yi tanımlayan bir addır. API Management örneğinde benzersiz olmalıdır.

  7. API'yi bir ürünle ilişkilendirin. Tam'ı seçtikten sonra, Ürünler kısmında ürünü seçin. 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 bunu bir ürüne eklemeniz gerekir.

    Not tutunuz

    Ürünler bir veya daha fazla API'nin ilişkilendirmeleridir. 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, bu üründeki tüm API'ler için uygun olan bir abonelik anahtarı alır. API Management örneğini oluşturduysanız yönetici olursunuz ve varsayılan olarak her ürüne abone olursunuz.

    Bazı fiyatlandırma katmanlarında, bir API Management örneği oluşturduğunuzda iki örnek ürünle birlikte gelir:

    • Başlangıç
    • Sınırsız
  8. Diğer API ayarlarını girin. Bu değerleri API'yi oluştururken veya daha sonra Ayarlar sekmesinde yapılandırırken ayarlayabilirsiniz. Bu ayarlar , İlk API'nizi içeri aktarma ve yayımlama öğreticisinde açıklanmıştır.

  9. Oluştur'u belirleyin.

    Kapsayıcı Uygulamasından Oluştur penceresini gösteren ekran görüntüsü.

Azure portalında yeni API'yi test edin

İşlemleri doğrudan Azure portalından çağırabilirsiniz. Bu yöntem, API'nin işlemlerini görüntülemenin ve test etmenin kullanışlı bir yoludur. API'yi geliştirici portalında veya kendi REST istemci araçlarınızı kullanarak da test edebilirsiniz.

API'yi Azure portalında test etmek için:

  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. Başlıklardan biri Ocp-Apim-Subscription-Key olarak geçiyor. Bu üst bilgi, API ile ilişkilendirilmiş ürünün abonelik anahtarına yöneliktir. API Management örneğini oluşturduysanız yönetici olduğunuz için anahtar otomatik olarak doldurulur.

  4. Gönder'i seçin.

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

Portalda joker karakter işlemini test edin

Genel karakter işlemleri oluşturulduğunda, bu işlemler doğrudan arka uç API'sine eşleşmeyebilir. Örneğin, API Yönetimi'nde içeri aktarılan joker karakter GET işlemi varsayılan olarak / yolunu kullanır. Ancak arka uç API'niz aşağıdaki yolda bir GET işlemini destekleyebilir:

/api/TodoItems

/api/TodoItems yolunu test etmek için:

  1. Oluşturduğunuz API'yi ve ardından 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 etme adımlarını gösteren ekran görüntüsü.

  4. Gönder'i seçin.

Diğer API'leri ekleme

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

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

Not tutunuz

Bir API'yi içeri aktardığınızda, işlemler geçerli API'nize eklenir.

Api'yi var olan bir API'ye eklemek için:

  1. Azure portalında Azure API Management örneğine gidin:

    API Management hizmetleri sayfasını gösteren ekran görüntüsü.

  2. Genel Bakış sayfasında API'ler'i veya kenar çubuğu menüsünde APIAPI'leri'ni seçin>.

    Genel Bakış sayfasındaki API'lerin seçimini gösteren ekran görüntüsü.

  3. Eklemek istediğiniz başka bir API'nin yanındaki üç noktayı (...) seçin.

  4. Bağlam menüsünden İçeri Aktar'ı seçin:

    İçeri Aktar komutunu gösteren ekran görüntüsü.

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