Veri API'si oluşturucusunda yapılandırmaya yönelik en iyi yöntemler

Şu konumlar da dahil olmak üzere dağıtım kılavuzu dizisinin şeması: Genel Bakış, Planlama, Hazırlama, Yayımlama, İzleme ve İyileştirme. 'İyileştir' konumu şu anda vurgulanmış durumda.

Bu makale, Veri API'sinin oluşturucusunda yapılandırma için önerilen en iyi yöntemleri içerir. Bu makale, Veri API'sini oluşturucu çözümünüz için yapılandırmanız gereken her şeyin kapsamlı bir listesini içermez.

Pascal biçimlendirmesi kullanarak varlıkları adlandırın

Yapılandırma dosyasına varlık eklerken, oluşturulan GraphQL türlerinin daha kolay okunabilmesi için PascalCasing kullanın. Örneğin, oluşturulan GraphQL şeması adlı CompositeNameEntity bir varlığınız varsa aşağıdaki sorgular ve mutasyonlar vardır:

• Sorular

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutasyon

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Eğer varlık bir saklı yordamla eşleniyorsa, oluşturulan sorgu veya mutasyon executeCompositeNameEntity olarak adlandırılır, ki bu daha kolay ve daha hoş okunur.

Varlıkları adlandırırken tekil form kullanma

Yapılandırma dosyasına varlık eklerken ad için tekil formu kullandığınızdan emin olun. Veri API oluşturucusu, söz konusu varlığın koleksiyonu döndürülürken otomatik olarak çoğul formu oluşturur. Ayrıca, yapılandırma dosyasına el ile ekleyerek tekil ve çoğul formları el ile de sağlayabilirsiniz. Daha fazla bilgi için bkz. GraphQL yapılandırma başvurusu.

Sonraki adım

En iyi güvenlik uygulamaları