Aracılığıyla paylaş

GraphQL şema görünümü ve Şema gezgini için Doku API'si

  • Makale

GraphQL Şema Tanım Dili'ni (SDL) temel alan GraphQL şeması, API'de kullanıma sunulan verilerin biçimini tanımlar. Bu, arka uç uygulama ayrıntılarını gizlerken tüketicilere esneklik sağlayan bir soyutlama katmanıdır. Şema, alan içeren nesne türleri koleksiyonunu temel alır.

Şema görünümü

Veri Geliştirme ekranının sol alt köşesindeki Şema'ya tıklayarak şema görünümüne erişebilirsiniz. Görünümde, oluşturulan türler, alanlar ve işlemler içeren GraphQL SDL'nin metin tabanlı bir sürümü gösterilir.

Aşağıdaki görüntü, bu şemada kullanılabilen nesnelerin kapsamlı bir listesi de dahil olmak üzere şema görünümüne bir örnektir.

Not

Şema görünümü salt okunurdur. Nesneleri yalnızca Şema gezgininde değiştirebilirsiniz.

Sol bölmedeki Şema gezginini içeren API şema görünümü ekranının ekran görüntüsü.

Şema gezgini

Şema gezgini soldaki bölmede bulunur ve sorgu görünümünde düzenleyiciyi kullandığınızda da kullanılabilir. Gezgin, kullanıcıların API'de tanımlanan kullanılabilir tür ve alanların yanı sıra sorguları ve mutasyonları hızla görselleştirmesine olanak tanır.

Bir veri kaynağına bağlanırken seçtiğiniz nesnelerden kullanılabilen tüm GraphQL türleri Şema gezgini listesinde görünür. Türler, türetildikleri veri kaynağının adı altında görünür. Aşağıdaki görüntüde, AdventureWorks SQL analiz uç noktasındaki SalesOrderDetail tablosundan türetilen SalesOrderDetail türünü görürsünüz.

SalesOrderDetail adlı örnek veri kaynağı altında kullanılabilen türlerin genişletilmiş listesini gösteren Şema gezgini bölmesinin ekran görüntüsü.

Türlerin yanı sıra GraphQL için Doku API'si, kullanıma sunmayı seçtiğiniz tüm yeni nesneler için otomatik olarak sorgular ve mutasyonlar oluşturur.

AdventureWorks örneğimizde sorgu listesini genişletmek, veri kaynağı için otomatik olarak oluşturulan sorguları gösterir.

Otomatik olarak oluşturulan sorguların genişletilmiş listesini gösteren Şema gezgini bölmesinin ekran görüntüsü.

API tarafından otomatik olarak oluşturulan mutasyonları görmek için Şema gezgini ağacındaki mutasyonlar düğümünü genişletin.

Otomatik olarak oluşturulan mutasyonların genişletilmiş listesini gösteren Şema gezgini bölmesinin ekran görüntüsü.

Şema gezginini kullanarak nesneleri değiştirme

API bunları sizin için oluşturduğunda nesneleri değiştirmek için Şema gezginini kullanabilirsiniz. Aşağıdaki örnekte, AdventureWorks veritabanımızdan türetilen SalesOrderDetail türünün yanındaki üç noktayı seçiyoruz:

Kullanılabilir menü seçeneklerini gösteren üç noktanın seçili olduğu Şema gezgininin ekran görüntüsü.

Türler için aşağıdaki seçenekler kullanılabilir:

  • Şemayı güncelleştirme - Şemayı veri kaynağındaki yeni nesnelerle güncelleştirmenize olanak tanır.
  • Yeniden Adlandır - Nesnenin adını değiştirir. LÜTFEN UNUTMAYIN: Bu değişiklik yalnızca API şemasını etkiler ve türetildiği özgün veri kaynağı nesnesi üzerinde hiçbir etkisi yoktur.
  • Şemadan kaldır - Nesneyi GraphQL şemasından etkili bir şekilde siler, böylece artık buna başvuramıyabilirsiniz.
  • İlişkileri yönetme - sizi ilişki yönetimi deneyimine götürür. Daha fazla bilgi için bkz . GraphQL için Doku API'sinde ilişkileri yönetme.
  • Özellikler - Nesne hakkında ek bilgileri gösterir.

Sorguları ve mutasyonları etkinleştirme ve devre dışı bırakma

Sorgular ve mutasyonlar için etkinleştirme/devre dışı bırakma özelliği, yöneticilere ve geliştiricilere API erişimi ve kullanımı üzerinde ayrıntılı denetim sağlar. GraphQL şemasında belirli sorguları ve mutasyonları seçmeli olarak etkinleştirmenize veya devre dışı bırakmanıza olanak tanır. Bu, kodu değiştirmeden veya değişiklikleri dağıtmadan API özelliklerini dinamik olarak yönetmenizi sağlar.

Şema gezginindeki sorgular ve mutasyonlar iki ek seçeneğe sahiptir:

  • Disable - İsteklerin sorguyu veya mutasyonu yürütmesini engeller. Yürütme denenirse bir hata döndürülür. Bir sorgu veya mutasyon devre dışı bırakıldıktan sonra şema yeniden yüklemesi gerçekleşir ve şema gezgininde sorgu veya mutasyon gri görünür.

Şema gezgininde gösterilen sorguyu veya mutasyonu devre dışı bırakma seçeneğinin ekran görüntüsü.

  • Etkinleştir - Daha önce devre dışı bırakılmış bir sorguyu veya mutasyonu yeniden etkinleştirin. Etkinleştir seçeneği belirtildikten sonra gerçekleşen şema yeniden yükleme işleminde öğenin yürütülmesi hemen kullanılabilir.

Şema gezgininde gösterilen mutasyon sorgusunu etkinleştirme seçeneğinin ekran görüntüsü.

Saklı yordamlardan otomatik olarak oluşturulan sorguların veya mutasyonların yalnızca silinebileceğini lütfen unutmayın. Silindikten sonra, Veri Al veya Şemayı Güncelleştir seçenekleri kullanılarak bunlar yeniden eklenebilir.

İlgili içerik