Công cụ định dạng & kiểm tra GraphQL

Công cụ kiểm tra những gì?

Khi không có schema, công cụ kiểm tra cú pháp: dấu ngoặc nhọn cân bằng, tên hợp lệ, cú pháp đối số và biến, cùng cách escape trong chuỗi và block string. Khi có schema, công cụ chạy toàn bộ quy tắc xác thực GraphQL theo đặc tả, tức là những quy tắc mà máy chủ GraphQL áp dụng trước khi thực thi một query:

• Mỗi trường phải tồn tại trên kiểu của nó. Trường lá (scalar, enum) không được có tập chọn lọc con, còn trường object thì bắt buộc phải có.
• Đối số phải tồn tại, các đối số bắt buộc phải được truyền và giá trị phải đúng kiểu.
• Biến phải được khai báo và sử dụng, đồng thời kiểu của biến phải khớp với nơi nó được dùng.
• Fragment phải được sử dụng, khớp với kiểu mà nó được spread vào và không tạo thành vòng lặp.
• Tên operation phải là duy nhất, và operation không có tên phải là operation duy nhất trong tài liệu.

Định dạng và thu gọn

Định dạng dùng hàm print tham chiếu từ graphql-js, nên kết quả khớp với những gì hầu hết công cụ GraphQL tạo ra: thụt lề hai khoảng trắng, mỗi trường một dòng và khoảng trắng quanh đối số được chuẩn hóa. Thu gọn sẽ bỏ comment và khoảng trắng không cần thiết, rất hữu ích cho các request GET và persisted query khi từng byte đều quan trọng. Cần tạo query từ schema? Hãy dùng công cụ tạo GraphQL query.

Cũng được tìm dưới tên: định dạng graphql, kiểm tra graphql online, format graphql query, graphql validator, làm đẹp graphql, rút gọn graphql, kiểm tra cú pháp graphql, định dạng sdl.

Các công cụ dùng kèm tốt với Công cụ định dạng & kiểm tra GraphQL

• Định dạng JSON — Dán JSON để định dạng đẹp, nén hoặc kiểm tra.
• Kiểm tra OpenAPI / Swagger — Dán đặc tả API vào để kiểm tra theo schema OpenAPI chính thức, phát hiện tham chiếu hỏng và tham số path không nhất quán, đồng thời xem toàn bộ endpoint chỉ trong một cái nhìn.
• Kiểm tra JSON Schema — Dán schema và dữ liệu JSON để xem chính xác giá trị nào vi phạm quy tắc nào, hoặc tạo schema ban đầu từ dữ liệu mẫu.
• Webhook Tester — Lấy một URL riêng, gửi webhook hoặc HTTP client của bạn tới đó và xem request đổ về ngay lập tức — header, query string và body đã được định dạng, cùng với kiểm tra chữ ký HMAC.