API Gezgini, bir projenin GraphQL API’sini keşfetmek için tarayıcı içi bir IDE’dir. Archie Core geliştiricilerinin çalışma alanından GraphQL sorgularını kolayca oluşturup çalıştırmasına olanak tanır.

API Gezgini gerçek, canlı üretim verilerinizi kullanır.

---

İçgörü (Introspection)

Bir GraphQL şeması, şemanın yapısını yayınlayan yerleşik bir içgörü sistemine sahiptir. Bu sayede API Gezgini, GraphQL sorguları yazarken güçlü otomatik tamamlama sunar.

items bloğunun içindeyken “em” yazın. Buradan API’deki kullanılabilir işlemler arasından email alanını görmek ve seçmek kolaydır. Otomatik tamamlama, oluşturduğunuz sorgudaki konumunuza göre bağlamsal çalışır ve yazdıklarınıza göre seçenekleri filtreler.

Otomatik tamamlama menüsünü elle açmak ve seçenekleri görmek için [Shift] + [SPACE] tuşlarına basın. Bu işlem bağlam menüsünü gösterir; listeden items gibi istediğiniz alanı seçebilirsiniz.

Ayrıca içgörü, sorgulardaki hataları tespit etmeye yardımcı olur. Sistem, farklı türlerin kullanılamıyor veya yanlış yapılandırılmış olduğu durumları tanır — örneğin Number yerine String olmalı, tabloda alan yok, doğrulamalar vb. Bu nedenle API Gezgini’ni kullanırken kırmızı dalgalı çizgilerin üzerine gelerek hata ipuçlarını görüntüleyin.

API belgelerine erişim

API Gezgini, sorgu yazarken veri modelinizi anlamanıza yardımcı olmak için yerleşik bir şema referansı içerir. Buna iki şekilde erişebilirsiniz:

1. Belgeler paneli

Sağ üstteki araç çubuğundaki Documentation düğmesine tıklayın. Solda bir kenar çubuğu açılır; burada tüm kullanılabilir Queries, Mutations ve Types öğelerine göz atabilir ve arama yapabilirsiniz.

2. Bağlamsal hızlı gezinme

Görselde gösterildiği gibi, yazmakta olduğunuz belirli bir alanın belgelerine doğrudan atlayabilirsiniz:

• Düzenleyicide bir alan adının (ör. cities) üzerine gelin. Araç ipucu, dönüş türünü (ör. CitiesConnection) gösterir.
• Araç ipucundaki tür adına tıklayın.
• Belgeler kenar çubuğu otomatik açılır ve o tür tanımına gider; items, count, aggregates gibi tüm alt alanları ve açıklamalarını görürsünüz.

Composer

Composer, API Gezgini’nin solunda genellikle varsayılan olarak açık olan görsel bir sorgu oluşturma aracıdır. Alanları ve argümanları seçerek geçerli GraphQL sözdizimini otomatik oluşturur.

Paneli kapattıysanız veya görmüyorsanız şu şekilde yeniden açabilirsiniz:

• Sağ üstteki araç çubuğunda Composer düğmesini arayın.
• Documentation düğmesinin hemen yanındadır.
• Bu düğmeye tıklamak Composer kenar çubuğunu açar/kapatır ve görsel düzenleyiciyi geri getirir.

cities öğesini açıp count seçeneğini deneyin. Aşağıdaki sorgu metin alanını doldurur; çalıştırarak kaç şehir olduğunu kontrol edebilirsiniz.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}