Önemli noktalar
- 01Resmi graphql.js ayrıştırıcısını kullanarak sorguları, mutasyonları, abonelikleri ve SDL şemalarını biçimlendir.
- 02Sözdizimini doğrula ve hatalara yönelik tam satır ve sütun raporları — şema gerekli değil.
- 03GraphQL açıklamaları (#) biçimlendirmede çıkarılır; korumak istediğiniz belgeler için açıklama dizilerini kullanın.
- 04Tamamen tarayıcınızda çalışır — iç API sorguları ve tescili şemalar özel kalır.
Neden GraphQL Belgelerini Biçimlendir?
GraphQL sorguları hızlı karmaşık hale gelebilir — iç içe geçmiş parçalar, satır içi değişkenler, birden fazla işlem tanımı ve arabirimler ve direktifler içeren SDL tür tanımları. Tutarlı biçimlendirme akran incelemesini hızlandırır ve eksik kapanış ayraçlarını veya bağımsız değişken uyumsuzluklarını bir bakışta görmek daha kolay hale getirir.
Biçimlendirici referans graphql.js ayrıştırıcısını kullanır — GraphQL belirtimi birlikte gelir. Bu, burada aldığın kurallı biçimlendirme Prettier'nin GraphQL eklentisi ve çoğu GraphQL araçlama ile eşleşir. Temiz ayrıştırılan her şey Apollo, Relay ve graphql-request'te temiz ayrıştırılır.
GraphQL Belgesi Nasıl Biçimlendirilir
- 01
GraphQL'ni yapıştır
Sorgu, mutasyon, abonelik, parça veya SDL şema tanımını girişi paneline yapıştır.
- 02
Biçimlendirme'ye tıkla
Ayrıştırıcı belgeyi kurallı girintilendirme ile yayınlar — iki boşluk girinti, satır başına bir alan, tutarlı bağımsız değişken hizalama. Sonuç çıktı panelinde görünür.
- 03
İsteğe bağlı olarak doğrula
Belgenin biçimlendirilmiş çıktı üretmeksizin ayrıştırılmadığını doğrulamak için Doğrula'ya tıkla. Sonuç bir onay veya satır ve sütun numaraları ile sözdizimi hataları listesidir.
- 04
Sonucu kopyala
Biçimlendirilmiş belgeyi almak için Kopyala'ya tıkla. Kod tabanına, PR açıklamasına veya dokümantasyon dosyasına yapıştır.
İç Şemalar ve API Sorguları için Güvenli
graphql.js ayrıştırıcı tamamen tarayıcınızda çalışır. İşlem metni veya şema tanımı sunucuya gönderilmez. Bu, özel alan adlarına veya üçüncü taraf araçlarına açığa çıkarmak istemeyeceğin iç tür sistemlerine başvuran sorguları biçimlendirmek için güvenli hale getirir.
Burada doğrulama yalnızca sözdizim — araç belgenin geçerli bir GraphQL belgesi olduğunu denetler, ama alan adlarının gerçek şemada var olup olmadığını, değişkenlerin bağımsız değişken türleriyle eşleşip eşleşmediğini veya direktiflerin doğru şekilde uygulanıp uygulanmadığını denetlemez. Şema-farkında doğrulama hedef şemanın belge yanında yüklenmesini gerektirir.
GraphQL Biçimlendirici SSS
GraphQL biçimlendirmesi şemaya karşı doğrular mı?
Hayır — yalnızca sözdizimi doğrulaması. Alanların ve bağımsız değişkenlerin var olup olmadığını kontrol etmek hedef şemasını gerektirir. Bu araç belgenin geçerli bir GraphQL belgesi olduğunu doğrular, başka bir şey değil.
GraphQL'mizdeki açıklamalar korunacak mı?
Hayır. # ile başlayan satırlar ayrıştırıcı tarafından çıkarılır. Biçimlendirme hayatta kalması gereken belgeler için üçlü alıntılı açıklama dizeleri kullanın.
Hangi GraphQL spec sürümü destekleniyor?
OneOf giriş nesneleri ve @specifiedBy direktifinin dahil olduğu Ekim 2021 belirtimi.
İşlem belgelerini değil SDL şema tanımlarını biçimlendirebilir miyim?
Evet. Tür tanımları, arabirim bildirimleri, birleşim türleri, numaralandırmalar, direktifler ve açıklamalar biçimlendirici aracılığıyla doğru şekilde gidiş-dönüş yapar.
Sorgu veya şema herhangi bir yere yüklenmez mi?
Hayır. graphql.js ayrıştırıcı tamamen tarayıcınızda çalışır — hiçbir şey cihazınızdan ayrılmaz.