GraphQL API 'sini içeri aktarma (Önizleme)

GraphQL, API 'Ler için açık kaynaklı, sektör standardı bir sorgu dilidir. Kaynak üzerinde eylemler etrafında tasarlanan uç nokta tabanlı (veya REST stili) API 'Lerinin aksine, GraphQL API 'Leri daha geniş bir kullanım durumu kümesini destekler ve veri türlerine, şemalara ve sorgulara odaklanılır.

API Management GraphQL API 'Leri ile birlikte gelen güvenlik, kimlik doğrulama ve yetkilendirme zorluklarını. GraphQL API 'lerinizi göstermek için API Management kullanarak şunları yapabilirsiniz:

  • Azure portal aracılığıyla API olarak GraphQL hizmeti ekleyin.
  • Hem var olan erişim denetimi ilkelerini hem de GraphQL 'e özgü saldırılara karşı korumak için Yeni bir ilke uygulayarak güvenli Graphql API 'leri sağlayın.
  • Şemayı araştırın ve test sorgularını Azure ve geliştirici portallarındaki GraphQL API 'Lerinde çalıştırın.

Önemli

API Management GraphQL API'si şu anda önizlemededir.

Bu makalede şunları yapmanız gerekir:

  • GraphQL API 'Lerini kullanmanın avantajları hakkında daha fazla bilgi edinin.
  • API Management örneğine GraphQL API 'SI ekleyin.
  • GraphQL API 'nizi test edin.
  • API Management 'de GraphQL API 'nizin sınırlamalarını öğrenin.

Önkoşullar

GraphQL API 'SI ekleme

  1. API Management örneğinize gidin.

  2. Yan gezinti menüsünde, API 'ler bölümünde API 'ler' i seçin.

  3. Yeni BIR API tanımla altında graphql simgesini seçin.

    API listesinden GraphQL simgesini seçme

  4. İletişim kutusunda tam ' ı seçin ve gerekli form alanlarını doldurun.

    GraphQL oluşturmak için alanları gösterir

    Alan Açıklama
    Görünen ad GraphQL API 'nizin görüntüleneceği ad.
    Name GraphQL API 'sinin ham adı. , Görünen adı yazarken otomatik olarak doldurulur.
    GraphQL API uç noktası GraphQL API uç noktası adınızın bulunduğu temel URL.
    Örneğin: https://example.com/your-GraphQL-name . Ortak "yıldızlı çatışmaları" GraphQL uç noktasını demo olarak da kullanabilirsiniz.
    Upload şema dosyası Şema dosyanıza gözatıp yüklemek için seçin.
    Description API 'nizin açıklamasını ekleyin.
    URL düzeni HTTP, HTTPS veya her Ikisini birden seçin. Varsayılan seçim: her ikisi.
    API URL’si soneki Bu API Management örneğinde bu özel API 'yi tanımlamak için bir URL soneki ekleyin. Bu API Management örneğinde benzersiz olmalıdır.
    Temel URL API taban URL 'nizi görüntüleyen düzenlenemeyen alan
    Etiketler GraphQL API 'nizi yeni veya mevcut etiketlerle ilişkilendirin.
    Ürünler GraphQL API 'nizi yayımlamak için bir ürünle ilişkilendirin.
    Ağ geçitleri GraphQL API 'nizi mevcut ağ geçitleri ile ilişkilendirin. Varsayılan ağ geçidi seçimi: yönetilen.
    Bu API'nin sürümü oluşturulsun mu? GraphQL API 'nizi sürüm denetimini seçin.
  5. Oluştur’a tıklayın.

GraphQL API 'nizi test etme

  1. API Management örneğinize gidin.

  2. Yan gezinti menüsünde, API 'ler bölümünde API 'ler' i seçin.

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

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

  5. Üst bilgiler:

    1. Ad açılan menüsünden üstbilgiyi seçin.
    2. Değer alanına değeri girin.
    3. + Üst bilgi Ekle seçeneğini belirleyerek daha fazla üst bilgi ekleyin.
    4. Çöp kutusu simgesini kullanarak üstbilgileri silin.
  6. GraphQL API 'nize bir ürün eklediyseniz ürün kapsamını Uygula altında ürün kapsamını uygulayın.

  7. Sorgu Düzenleyicisi altında aşağıdakilerden birini yapın:

    1. Yan menüdeki listeden en az bir alan veya alt alan seçin. Seçtiğiniz alanlar ve alt alanlar sorgu Düzenleyicisi 'nde görünür.

    2. Sorgu oluşturmak için sorgu Düzenleyicisi ' ne yazmaya başlayın.

      Sorgu düzenleyicisine alan ekleme gösterimi

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

  9. Gönder’e tıklayın.

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

    Test sorgu yanıtını görüntüleme

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

  12. Sınama tamamlandığında, test konsolundan çıkın.

Sınırlamalar

  • Yalnızca GraphQL geçişi desteklenir.
  • API Management tek bir GraphQL API 'SI yalnızca tek bir GraphQL uç noktasına karşılık gelir.

Sonraki adımlar