Praktik terbaik konfigurasi di penyusun API Data

Diagram urutan panduan penyebaran termasuk lokasi ini, secara berurutan: Gambaran Umum, Rencana, Siapkan, Terbitkan, Pantau, dan Pengoptimalan. Lokasi 'Optimalkan' saat ini disorot.

Artikel ini mencakup praktik terbaik yang direkomendasikan saat ini untuk konfigurasi di penyusun API Data. Artikel ini tidak menyertakan daftar lengkap semua yang harus Anda konfigurasi untuk solusi penyusun API Data Anda.

Nama entitas dengan menggunakan casing Pascal

Saat menambahkan entitas ke file konfigurasi, gunakan PascalCasing, sehingga jenis GraphQL yang dihasilkan lebih mudah dibaca. Misalnya, jika Anda memiliki entitas bernama CompositeNameEntity skema GraphQL yang dihasilkan memiliki kueri dan mutasi berikut:

• Pertanyaan

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutasi

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Jika entitas memetakan ke prosedur tersimpan, kueri atau mutasi yang dihasilkan akan diberi nama executeCompositeNameEntity, yang lebih mudah dan lebih baik untuk dibaca.

Gunakan bentuk tunggal saat menamai entitas

Saat menambahkan entitas ke file konfigurasi, pastikan untuk menggunakan formulir tunggal untuk nama tersebut. Penyusun API Data secara otomatis menghasilkan formulir jamak setiap kali kumpulan entitas tersebut dikembalikan. Anda juga dapat menyediakan formulir tunggal dan jamak secara manual, dengan menambahkannya secara manual ke file konfigurasi. Untuk informasi selengkapnya, lihat Referensi konfigurasi GraphQL.

Langkah selanjutnya

Praktik terbaik keamanan