GraphQL API'lerini içeri aktarma

UYGULANANLAR: Tüm API Management katmanları

API Management'ta, iki modelden birine GraphQL API'sini ekleyebilirsiniz: mevcut bir GraphQL uç noktasına geçiş yapın veya bir GraphQL şemasını içeri aktarın ve özel alan çözümleyicileriyle yapay bir GraphQL API oluşturun. Daha fazla bilgi için bkz. GraphQL'e genel bakış.

Bu makalede şunları yapacaksınız:

• API Management örneğinize doğrudan GraphQL API'sini ekleyin.
• GraphQL API'nizi test edin.

Bir GraphQL şemasını içeri aktarmak ve REST veya SOAP API uç noktalarını kullanan alan çözümleyicileri ayarlamak istiyorsanız bkz. GraphQL şemasını içeri aktarma ve alan çözümleyicilerini ayarlama.

Önkoşullar

• Azure API Management örneği. Henüz oluşturmadıysanız bir tane oluşturun.

• API'yi içeri aktarmak için kullanmak istiyorsanız Azure CLI.

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

    

  • CLI referans komutlarını yerel olarak çalıştırmayı tercih ediyorsanız, Azure CLI'yi yükleyin. Windows veya macOS üzerinde çalışıyorsanız, Azure CLI'yi bir Docker konteynerinde çalıştırmayı düşünün. Daha fazla bilgi için Azure CLI'nin bir Docker konteynerında nasıl çalıştırılacağını inceleyin.

    • Yerel bir kurulum kullanıyorsanız, az login komutunu kullanarak Azure CLI'ye giriş yapın. Kimlik doğrulama işlemini tamamlamak için, terminalinizde görüntülenen adımları takip edin. Diğer oturum açma seçenekleri için bkz. Azure CLI kullanarak Azure'da kimlik doğrulaması.

    • İ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 ve yönetme.

    • Yüklü olan sürümü ve bağımlı kütüphaneleri 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'i API'yi içeri aktarmak için kullanmak istiyorsanız.

  • 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ış .

GraphQL API'sini ekleme

Portal

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

2. Sol bölmede API API'leri'ni> seçin.

3. API Ekle'yi seçin.

4. Yeni API tanımla'nın altında GraphQL kutucuğunu seçin.

   

5. Sonuç iletişim kutusunda Tam'ı seçin ve aşağıdaki tabloda açıklandığı gibi gerekli alanlara değerleri girin.

   

   Değer	Açıklama
   Görüntü adı	GraphQL API'nizin görüntüleneceği ad.
   İsim	GraphQL API'sinin ham adı. Görüntüleme adını yazarken otomatik olarak doldurulur.
   GraphQL türü	Mevcut bir GraphQL API uç noktasından içeri aktarmak için Geçişli GraphQL'i seçin.
   GraphQL API uç noktası	GraphQL API uç noktanızın adını içeren temel URL. Örneğin: https://example.com/your-GraphQL-name. Tanıtım amacıyla gibi https://swapi-graphql.azure-api.net/graphql ortak bir SWAPI GraphQL uç noktası da kullanabilirsiniz.
   Şema yükle	İsteğe bağlı olarak, GraphQL uç noktasından alınan şemayı (varsa) değiştirmek için şema dosyanızı karşıya yüklemeyi seçin.
   Açıklama	API'nizin açıklamasını ekleyin.
   URL düzeni	GraphQL uç noktanızı temel alan bir düzen seçin. GraphQL API'niz abonelik türünü içeriyorsa WebSocket şeması (WS veya WSS) içeren seçeneklerden birini seçin. Varsayılan seçim HTTP(S)'dir.
   API URL uzantısı	API Management örneğindeki belirli API'yi tanımlamak için bir URL son eki ekleyin. API Management örneğinde benzersiz olmalıdır.
   Temel URL	API temel URL'nizi görüntüleyen düzenlenemez alan.
   Etiketler	İsteğe bağlı olarak GraphQL API'nizi yeni veya mevcut etiketlerle ilişkilendirin.
   Ürünler	Yayımlamak için GraphQL API'nizi bir ürünle ilişkilendirin.
   Bu API'nin sürümlendirilmesi mi gerekiyor?	GraphQL API'nize sürüm oluşturma şeması uygulamak için onay kutusunu seçin.

6. Oluştur'i seçin.

7. API oluşturulduktan sonra Şema sekmesinde şemayı gözden geçirin veya değiştirin.

Azure CLI

Aşağıdaki örnek, belirtilen URL'den apim-hello-world adlı bir API Management örneğine GraphQL geçiş API'sini içeri aktarmak için az apim api import komutunu kullanır.

# Details specific to API Management instance.
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details.
APIId="my-graphql-api"
APIPath="myapi"
DisplayName="MyGraphQLAPI"
SpecificationFormat="GraphQL"
SpecificationURL="<GraphQL backend endpoint>"

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

API'yi içeri aktardıktan sonra, gerekirse az apim api update komutunu kullanarak ayarları güncelleştirebilirsiniz.

PowerShell

Aşağıdaki örnek, belirtilen URL'den apim-hello-world adlı bir API Management örneğine GraphQL geçiş API'sini içeri aktarmak için Import-AzApiManagementApi Azure PowerShell cmdlet'ini kullanır.

# Details specific to API Management instance.
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific details.
$apiId = "my-graphql-api"
$apiPath = "myapi"
$specificationFormat = "GraphQL"
$specificationUrl = "<GraphQL backend endpoint>"

# 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

API'yi içeri aktardıktan sonra, gerekirse Set-AzApiManagementApi cmdlet'ini kullanarak ayarları güncelleştirebilirsiniz.

GraphQL API'nizi test edin

1. API Management örneğine gidin.

2. Sol bölmedeki API'ler bölümünde API'ler'i seçin.

3. Tüm API'ler'in altında GraphQL API'nizi seçin.

4. Test konsoluna erişmek için Test sekmesini seçin.

5. Başlıklar altında:

   1. Ad menüsünden başlığı seçin.
   2. Değer kutusuna değeri girin.
   3. Üst bilgi ekle'yi seçerek daha fazla üst bilgi ekleyin.
   4. Geri dönüşüm kutusu düğmesini kullanarak üst bilgileri silin.

6. GraphQL API'nize bir ürün eklediyseniz, Ürün kapsamını uygula'nın altına bir ürün kapsamı ekleyin.

7. Sorgu düzenleyicisinde aşağıdakilerden birini yapın:

   1. Düzenleyicinin sol tarafındaki menüden en az bir alan veya alt alan seçin. Seçtiğiniz alanlar ve alt alanlar sorgu düzenleyicisinde görünür.

   2. Sorgu oluşturmak için sorgu düzenleyicisinde yazmaya başlayın.

      

8. Sorgu değişkenleri'nin altında, aynı sorguyu veya mutasyonu yeniden kullanmak ve farklı değerler geçirmek için değişkenler ekleyin.

9. Gönder'i seçin.

10. Yanıtı görüntüleyin.

    

11. Farklı yükleri test etmek için önceki adımları yineleyin.

12. Testi tamamladığınızda test konsolundan çıkın.

Aboneliği test etme

GraphQL API'niz bir aboneliği destekliyorsa bunu test konsolunda test edebilirsiniz.

1. API'nizin API'nize uygun bir WebSocket URL düzenine (WS veya WSS) izin verdiğinden emin olun. Bu ayarı Ayarlar sekmesinde etkinleştirebilirsiniz.

2. Sorgu düzenleyicisinde bir abonelik sorgusu ayarlayın ve ardından Bağlan'ı seçerek arka uç hizmetine bir WebSocket bağlantısı oluşturun.

   

3. Abonelik bölmesinde bağlantı ayrıntılarını gözden geçirin.

   

4. Abone olunan olaylar Abonelik bölmesinde görünür. WebSocket bağlantısı, bağlantıyı kesene veya yeni bir WebSocket aboneliğine bağlanana kadar korunur.

   

GraphQL API'nizin güvenliğini sağlama

GraphQL'e özgü saldırılara karşı korumak için hem mevcut kimlik doğrulama ve yetkilendirme ilkelerini hem de GraphQL doğrulama ilkesini uygulayarak GraphQL API'nizin güvenliğini sağlayın.

İlgili içerik

• 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 dönüştürme
• App Service API'sini içeri aktarma
• Kapsayıcı uygulaması 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
• İşlev uygulaması API'sini içeri aktarma
• Mantıksal uygulama API'sini içeri aktarma
• Service Fabric hizmetlerini içeri aktarma
• Azure AI Foundry API'lerini içeri aktarma
• Azure OpenAI API'lerini içeri aktarma
• LLM API'lerini içeri aktarma
• OData API'sini içeri aktarma
• REST API'yi MCP sunucusu olarak dışarı aktarma
• Mevcut bir MCP sunucusunu kullanıma sunma
• A2A aracı API'lerini içeri aktarma
• SAP OData meta verilerini içeri aktarma
• gRPC API'lerini içeri aktarma
• API’yi düzenleme