Trình định dạng GraphQL

Cách dùng

1. 1 Dán vào một query, mutation, subscription hoặc SDL của GraphQL.
2. 2 Beautify sẽ định dạng lại bằng trình in (printer) <code class="rounded bg-slate-100 px-1 text-xs dark:bg-slate-800">graphql/language</code> chính thức.
3. 3 Minify loại bỏ khoảng trắng và chú thích để truyền tải gọn nhẹ hơn.
4. 4 Lỗi phân tích cú pháp sẽ hiển thị kèm số dòng và cột.

Vì sao dùng công cụ này

• Sử dụng các hàm parse và print chính thức của <code class="rounded bg-slate-100 px-1 text-xs dark:bg-slate-800">graphql/language</code> — đầu ra là SDL chuẩn (canonical).
• Tải theo nhu cầu — trình phân tích chỉ được tải xuống khi bạn bắt đầu nhập.
• Hỗ trợ cả hai chiều — beautify để lưu trong repo, minify để truyền tải.
• Xử lý hoàn toàn phía client — query của bạn không bao giờ rời khỏi trình duyệt.

Câu hỏi thường gặp

Trình định dạng GraphQL là gì?

Trình định dạng GraphQL (GraphQL Formatter) là công cụ giúp định dạng đẹp các query, mutation và schema definition language (SDL) của GraphQL bằng trình phân tích graphql/language chính thức. Công cụ phân tích cú pháp đầu vào rồi tái tạo lại với thụt lề và khoảng trắng nhất quán, tạo ra các tài liệu GraphQL dễ đọc, có cấu trúc rõ ràng ngay trên trình duyệt.

Tính năng

Ví dụ

{ user(id:1){name posts{title}} }

{
  user(id: 1) {
    name
    posts {
      title
    }
  }
}

Trường hợp sử dụng

1. 1

   Dọn dẹp query đã sao chép

   Định dạng lại một query GraphQL viết trên một dòng hoặc lộn xộn thành dạng dễ đọc, có thụt lề.

2. 2

   Dọn dẹp SDL

   Chuẩn hóa khoảng cách của một file schema trước khi commit hoặc review.

3. 3

   Xác thực trong khi định dạng

   Lỗi cú pháp sẽ chỉ ra chính xác lỗi sai trước khi bạn gửi query.

Tài liệu tham khảo

• GraphQL Specification — GraphQL Foundation
• graphql-js — reference implementation — GitHub

Công cụ liên quan