Công cụ định dạng GraphQL

Định dạng GraphQL là gì?

Công cụ định dạng GraphQL làm đẹp các thao tác GraphQL (query, mutation, subscription, fragment) và ngôn ngữ định nghĩa schema (SDL) với thụt lề nhất quán. Chú thích được giữ nguyên.

Cách sử dụng Định dạng GraphQL

1. Dán một query hoặc schema GraphQL.
2. Chọn Thụt lề.
3. Bấm Định dạng (kết quả cũng cập nhật khi bạn gõ).
4. Sao chép hoặc tải xuống GraphQL đã định dạng.

Ví dụ

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

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

Khi nào nên dùng Định dạng GraphQL

Dùng để đọc query đã rút gọn bắt được từ request mạng, định dạng thao tác cho tài liệu hoặc kiểm tra cú pháp query. Công cụ không kiểm tra các trường theo schema của bạn.

Định dạng GraphQL hoạt động như thế nào

Tài liệu được định dạng bằng plugin GraphQL của Prettier, plugin này phân tích bằng parser tham chiếu graphql-js rồi in mỗi selection set trên các dòng thụt lề riêng, chuẩn hóa khoảng cách của tham số và biến, đồng thời ngắt dòng các danh sách tham số dài. Vì Prettier giữ chú thích (khác với graphql.print), các # comments vẫn còn. Lỗi phân tích được báo kèm dòng và cột.

Các Trường Hợp Sử Dụng Phổ Biến

• ✓ Đọc query một dòng sao chép từ dev tools của trình duyệt
• ✓ Định dạng file schema trước khi review
• ✓ Chuẩn bị ví dụ GraphQL cho tài liệu
• ✓ Kiểm tra nhanh cú pháp query

Câu Hỏi Thường Gặp

Khám phá thêm danh mục