Share via


Yapay GraphQL API'sini ekleme ve alan çözümleyicilerini ayarlama

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:

  • GraphQL şemasını API Management örneğine aktarma
  • Mevcut HTTP uç noktasını kullanarak GraphQL sorgusu için çözümleyici ayarlama
  • GraphQL API'nizi test edin

Mevcut bir GraphQL uç noktasını API olarak kullanıma açmak istiyorsanız bkz . GraphQL API'sini içeri aktarma.

Önkoşullar

  • Mevcut bir API Management örneği. Henüz oluşturmadıysanız bir tane oluşturun.
  • Uzantılı .graphql geçerli bir GraphQL şema dosyası.
  • Bu senaryo için arka uç GraphQL uç noktası isteğe bağlıdır.

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

GraphQL şeması ekleme

  1. Yan gezinti menüsünde, API'ler bölümünün altında API'ler'i seçin.

  2. Yeni API tanımla'nın altında GraphQL simgesini seçin.

    API'ler listesinden GraphQL simgesini seçme işleminin ekran görüntüsü.

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

    GraphQL API'sini oluşturmaya yönelik alanların ekran görüntüsü.

    Alan Veri Akışı Açıklaması
    Görünen ad GraphQL API'nizin görüntüleneceği ad.
    Ad GraphQL API'sinin ham adı. Görünen adı yazarken otomatik olarak doldurulur.
    GraphQL türü GraphQL şema dosyasından içeri aktarmak için Yapay GraphQL'i seçin.
    Geri dönüş GraphQL uç noktası İsteğe bağlı olarak GraphQL API uç noktası adına sahip bir URL girin. Api Management, bir alan için özel çözümleyici ayarlı olmadığında GraphQL sorgularını bu uç noktaya geçirir.
    Açıklama API'nizin açıklamasını ekleyin.
    URL düzeni GraphQL uç noktanızı temel alan bir seçim yapın. 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).
    API URL’si soneki Bu API Management örneğinde bu API'yi tanımlamak için bir URL son eki ekleyin. Bu API Management örneğinde benzersiz olmalıdır.
    Temel URL API temel URL'nizi görüntüleyen düzenlenemez alan
    Etiketler 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ümü ne olacak? GraphQL API'nize sürüm oluşturma şeması uygulamak için seçin.
  4. Oluştur'u belirleyin.

  5. API oluşturulduktan sonra Tasarım sekmesinde şemaya göz atın veya şemayı değiştirin.

Çözümleyiciyi yapılandırma

Şemadaki bir alanı var olan bir HTTP uç noktasına eşlemek için bir çözümleyici yapılandırın. Burada üst düzey adımlar sağlanır. Ayrıntılar için bkz . GraphQL çözümleyicisini yapılandırma.

Aşağıdaki temel GraphQL şemasını içeri aktardığınız ve kullanıcılar sorgusu için bir çözümleyici ayarlamak istediğinizi varsayalım.

type Query {
    users: [User]
}

type User {
    id: String!
    name: String!
}
  1. Yan gezinti menüsündeki API'ler bölümünün altında GraphQL API'nizin API'lerini> seçin.

  2. Şema sekmesinde, çözümleyiciyi yapılandırmak istediğiniz nesne türündeki bir alanın şemasını gözden geçirin.

    1. Bir alan seçin ve sol kenar boşluğunda işaretçinin üzerine gelin.

    2. + Çözümleyici Ekle'yi seçin

      Portalda GraphQL çözümleyicisi ekleme işleminin ekran görüntüsü.

  3. Çözümleyici Oluştur sayfasında:

    1. İsterseniz Name özelliğini güncelleştirin, isteğe bağlı olarak bir Açıklama girin ve Tür ve Alan seçimlerini onaylayın veya güncelleştirin.
    2. Veri kaynağı'nda HTTP API'sini seçin.
  4. Çözümleyici ilkesi düzenleyicisinde, öğesini senaryonuz için alt öğelerle güncelleştirin<http-data-source>. Örneğin, aşağıdaki çözümleyici mevcut bir HTTP veri kaynağına çağrı yaparak GET kullanıcılar alanını alır.

        <http-data-source>
            <http-request>
                <set-method>GET</set-method>
                <set-url>https://myapi.contoso.com/users</set-url>
            </http-request>
        </http-data-source>
    

    Portalda çözümleyici ilkesini yapılandırma işleminin ekran görüntüsü.

  5. Oluştur'u belirleyin.

  6. Şemadaki başka bir alanın verilerini çözümlemek için yukarıdaki adımları yineleyerek çözümleyici oluşturun.

İpucu

Çözümleyici ilkesini düzenlerken, şemaya göre doğrulayabileceğiniz veri kaynağı çıkışını denetlemek için Testi Çalıştır'ı seçin. Hatalar oluşursa, yanıt sorun giderme bilgilerini içerir.

GraphQL API'nizi test edin

  1. API Management örneğine gidin.

  2. Yan gezinti menüsünde, API'ler bölümünün altında 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. Üst Bilgiler altında:

    1. Ad açılan menüsünden üst bilgiyi seçin.
    2. Değer alanına değeri girin.
    3. + Üst bilgi ekle'yi seçerek daha fazla üst bilgi ekleyin.
    4. Çöp kutusu simgesini kullanarak üst bilgileri 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'nin altında:

    1. Yan menüdeki listeden 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.

      Sorgu düzenleyicisine alan ekleme işleminin ekran görüntüsü.

  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.

    Test sorgusu yanıtını görüntüleme işleminin ekran görüntüsü.

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

  12. Test tamamlandığında, test konsolunda çıkın.

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.

Sonraki adımlar