OpenAPI belirtimini içeri aktarma

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, çeşitli araçları kullanarak "OpenAPI belirtimi" arka uç API'sini Azure API Management'a aktarma işlemi gösterilmektedir. Makalede AYRıCA API Management'ta API'yi test etme adımları da gösterilmektedir.

Bu makalede şunları öğreneceksiniz:

Önkoşullar

• Api Management örneği. Henüz bir örneğiniz yoksa şu hızlı başlangıcı tamamlayın: Azure API Management örneği oluşturma.

• Azure CLI

  • Azure Cloud Shell'de Bash ortamını kullanın. Daha fazla bilgi için bkz . Azure Cloud Shell'de Bash için hızlı başlangıç.

    

  • CLI başvuru komutlarını yerel olarak çalıştırmayı tercih ediyorsanız Azure CLI'yı yükleyin . Windows veya macOS üzerinde çalışıyorsanız Azure CLI’yi bir Docker kapsayıcısında çalıştırmayı değerlendirin. Daha fazla bilgi için bkz . Docker kapsayıcısında Azure CLI'yi çalıştırma.

    • Yerel yükleme kullanıyorsanız az login komutunu kullanarak Azure CLI ile oturum açın. Kimlik doğrulama işlemini tamamlamak için terminalinizde görüntülenen adımları izleyin. Diğer oturum açma seçenekleri için bkz . Azure CLI ile oturum açma.

    • İstendiğinde, ilk kullanımda Azure CLI uzantısını yükleyin. Uzantılar hakkında daha fazla bilgi için bkz. Azure CLI ile uzantıları kullanma.

    • Yüklü sürümü ve bağımlı kitaplıkları bulmak için az version komutunu çalıştırın. En son sürüme yükseltmek için az upgrade komutunu çalıştırın.

• Azure PowerShell

  • Azure PowerShell'i yerel olarak kullanmayı seçerseniz:
    • Az PowerShell modülünün en son sürümünü yükleyin.
    • Connect-AzAccount cmdlet'ini kullanarak Azure hesabınıza bağlanın.
  • Azure Cloud Shell'i kullanmayı seçerseniz:
    • Daha fazla bilgi için bkz . Azure Cloud Shell'e genel bakış.

Arka uç API'lerini içeri aktarma

Bu örnekte, açık kaynak Petstore API'si için OpenAPI belirtimini içeri aktarırsınız, ancak tercih ettiğiniz bir OpenAPI belirtimini değiştirebilirsiniz.

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="swagger-petstore"
APIPath="store"
SpecificationFormat="OpenAPI"
SpecificationURL="https://petstore3.swagger.io/api/v3/openapi.json"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --specification-format $SpecificationFormat --specification-url $SpecificationURL

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details
$apiId = "swagger-petstore"
$apiPath = "store"
$specificationFormat = "OpenAPI"
$specificationUrl = "https://petstore3.swagger.io/api/v3/openapi.json"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath

OpenAPI belirtimlerini görüntüleme ve düzenleme

Portalda, içeri aktardığınız API'nin belirtimini görüntülemek, doğrulamak veya düzenlemek için OpenAPI belirtim düzenleyicisini kullanın.

OpenAPI belirtim düzenleyicisini kullanmak için:

1. Azure portalında API Management örneğine gidin.
2. Soldaki menüde, API'ler'in altında API'leriniz<>Tüm işlemler'i>> seçin.
3. Tasarım sekmesinde, Ön uçta OpenAPI Belirtimi düzenleyicisini (kalem simgesi) seçin. Belirtimi JSON veya YAML biçiminde açabilirsiniz.
4. Belirtimi gerektiği gibi gözden geçirin veya düzenleyin. Değişikliklerinizi kaydedin.

OpenAPI belirtimi şemasına göre doğrulama

OpenAPI belirtimindeki şemaya göre istekleri ve yanıtları (veya bunların öğelerini) doğrulamak için API Management doğrulama ilkelerini yapılandırabilirsiniz. Örneğin, istek veya yanıt gövdesinin boyutunu veya içeriğini doğrulamak için validate-content ilkesini kullanın.

Portalda yeni API'yi test edin

İşlemler doğrudan portaldan çağrılabilir ve bu da yöneticilerin bir API'nin işlemlerini görüntülemesi ve test edebilmesi için kullanışlı bir yol sağlar.

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.

   Not

   Test konsolunda API Management otomatik olarak bir Ocp-Apim-Subscription-Key üst bilgisini doldurur ve yerleşik tüm erişimli aboneliğin abonelik anahtarını yapılandırılır. Bu anahtar, API Management örneğindeki her API'ye erişim sağlar. İsteğe bağlı olarak HTTP İsteği'nin yanındaki "göz" simgesini seçerek Ocp-Apim-Subscription-Key üst bilgisini görüntüleyin.

4. İşleme bağlı olarak sorgu parametresi değerlerini, üst bilgi değerlerini veya istek gövdesini girin. Gönder'i seçin.

   Test başarılı olduğunda, arka uç başarılı bir HTTP yanıt kodu ve bazı verilerle yanıt verir.

   İpucu

   Varsayılan olarak, test konsolu API Management'ın CORS ara sunucusuna bir istek gönderir ve bu da isteği API Management örneğine iletir ve ardından arka uçta iletir. Bu proxy 13.91.254.72 genel IP adresini kullanır ve yalnızca genel uç noktalara ulaşabilir. Doğrudan tarayıcıdan API Management hizmetine istek göndermek istiyorsanız CORS proxy'sini atla'yı seçin. Test konsolunu kullanmak istediğinizde ve API Management ağ geçidiniz ağdan yalıtılmışsa veya CORS proxy'sinden gelen trafiğe izin vermiyorsa bu seçeneği kullanın.

API'de hata ayıklamak için bkz . Öğretici: İstek izleme kullanarak API'lerinizde hata ayıklama.

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.

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