Formatter GraphQL

Format query, mutation, fragment, dan skema SDL GraphQL dengan Prettier sambil mempertahankan komentar. Error sintaks tampil dengan baris dan kolom. Gratis.

Keluaran

Berjalan sepenuhnya di browser Anda. Data Anda tidak pernah diunggah.

Alat Terkait

Lihat Semua

Apa itu Formatter GraphQL?

Formatter GraphQL mem-pretty-print operasi GraphQL (query, mutation, subscription, fragment) dan schema definition language (SDL) dengan indentasi konsisten. Komentar dipertahankan.

Cara menggunakan Formatter GraphQL

  1. Tempel query atau skema GraphQL.
  2. Pilih Indentasi.
  3. Klik Format (keluaran juga diperbarui saat Anda mengetik).
  4. Salin atau unduh GraphQL yang sudah diformat.

Contoh

Masukan
query { user(id: 1) { name } }
Keluaran
query {
  user(id: 1) {
    name
  }
}

Kapan menggunakan Formatter GraphQL

Pakai untuk membaca query yang di-minify dan ditangkap dari permintaan jaringan, memformat operasi untuk dokumentasi, atau memeriksa sintaks query. Alat ini tidak memvalidasi field terhadap skema Anda.

Cara kerja Formatter GraphQL

Dokumen diformat dengan plugin GraphQL Prettier, yang mem-parse-nya dengan parser graphql-js referensi dan mencetak setiap selection set di baris berindentasi sendiri, argumen dan variabel dengan spasi ternormalisasi, serta daftar argumen panjang dibungkus. Karena Prettier mempertahankan komentar (tidak seperti graphql.print), # komentar tetap ada. Error parse dilaporkan dengan baris dan kolom.

Kasus Penggunaan Umum

  • Membaca query satu baris yang disalin dari dev tools browser
  • Memformat file skema sebelum ditinjau
  • Menyiapkan contoh GraphQL untuk dokumentasi
  • Memeriksa sintaks query dengan cepat

Catatan Keamanan

Semuanya berjalan secara lokal di browser Anda; kode yang Anda tempel tidak diunggah.

Pertanyaan Umum

Apakah ia memvalidasi terhadap skema saya?

Tidak, hanya sintaks GraphQL.

Apakah komentar dipertahankan?

Ya.

Bisakah memformat definisi tipe SDL?

Ya, skema dengan definisi type, input, enum, dan directive didukung.

Jelajahi kategori lainnya