Poin penting
- 01Memformat kueri, mutasi, langganan, dan skema SDL menggunakan parser graphql.js resmi.
- 02Memvalidasi sintaks dan melaporkan baris dan kolom yang tepat untuk kesalahan — tidak ada skema yang diperlukan.
- 03Komentar GraphQL (#) dihapus saat pemformatan; gunakan string deskripsi untuk dokumentasi yang ingin Anda pertahankan.
- 04Berjalan sepenuhnya di browser Anda — kueri API internal dan skema proprietary tetap pribadi.
Mengapa Memformat Dokumen GraphQL?
Kueri GraphQL dapat menjadi kompleks dengan cepat — fragmen bersarang, variabel inline, definisi operasi beberapa, dan definisi tipe SDL dengan interface dan directive. Pemformatan konsisten membuat peer review lebih cepat dan memudahkan untuk menangkap kurung kurawal yang hilang atau ketidakcocokan argumen sekilas.
Pemformat menggunakan parser graphql.js referensi — parser yang sama yang dikirimkan spesifikasi GraphQL. Itu berarti pemformatan kanonik yang Anda dapatkan di sini cocok dengan apa yang dihasilkan plugin GraphQL Prettier dan sebagian besar alat GraphQL. Apa pun yang diparse dengan bersih di sini akan diparse dengan bersih di Apollo, Relay, dan graphql-request.
Cara Memformat Dokumen GraphQL
- 01
Tempel GraphQL Anda
Tempel kueri, mutasi, langganan, fragmen, atau definisi skema SDL ke panel input.
- 02
Klik Format
Parser memancarkan dokumen dengan indentasi kanonik — indent 2 spasi, satu field per baris, alignment argumen konsisten. Hasilnya muncul di panel output.
- 03
Validasi secara opsional
Klik Validasi untuk mengkonfirmasi dokumen diparse tanpa menghasilkan output yang diformat. Hasilnya adalah konfirmasi atau daftar kesalahan sintaks dengan nomor baris dan kolom.
- 04
Salin hasilnya
Klik Salin untuk mengambil dokumen yang diformat. Tempel ke codebase, deskripsi PR, atau file dokumentasi Anda.
Aman untuk Skema Internal dan Kueri API
Parser graphql.js berjalan sepenuhnya di browser Anda. Tidak ada teks operasi atau definisi skema yang dikirim ke server apa pun. Itu membuatnya aman untuk memformat kueri yang mereferensikan nama field pribadi atau sistem tipe internal yang tidak ingin Anda paparkan ke alat pihak ketiga.
Validasi di sini hanya sintaktis — alat memeriksa bahwa dokumen adalah dokumen GraphQL yang valid, tetapi tidak memeriksa apakah nama field ada dalam skema nyata, apakah variabel cocok dengan jenis argumen, atau apakah directive diterapkan dengan benar. Validasi sadar skema memerlukan skema target dimuat bersama dokumen.
FAQ Pemformat GraphQL
Apakah pemformatan GraphQL memvalidasi terhadap skema?
Tidak — hanya validasi sintaks. Memeriksa apakah field dan argumen ada memerlukan skema target. Alat ini mengkonfirmasi dokumen adalah dokumen GraphQL yang valid, tidak lebih.
Apakah komentar dalam GraphQL saya akan dipertahankan?
Tidak. Baris yang dimulai dengan # dihapus oleh parser. Gunakan string deskripsi dengan tiga kutip untuk dokumentasi yang harus bertahan dari pemformatan.
Versi spesifikasi GraphQL mana yang didukung?
Spesifikasi Oktober 2021, termasuk input objek OneOf dan directive @specifiedBy.
Bisakah saya memformat definisi skema SDL, bukan hanya dokumen operasi?
Ya. Definisi tipe, deklarasi interface, tipe union, enum, directive, dan deskripsi semuanya round-trip dengan benar melalui pemformat.
Apakah kueri atau skema diunggah di mana pun?
Tidak. Parser graphql.js berjalan sepenuhnya di browser Anda — apa pun tidak meninggalkan perangkat Anda.