Những điểm chính
- 01Định dạng các truy vấn, đột biến, đăng ký và lược đồ SDL bằng cách sử dụng trình phân tích graphql.js chính thức.
- 02Xác thực cú pháp và báo cáo dòng và cột chính xác cho các lỗi — không cần lược đồ.
- 03Các bình luận GraphQL (#) bị tước khi định dạng; sử dụng các chuỗi mô tả cho tài liệu bạn muốn bảo tồn.
- 04Chạy hoàn toàn trong trình duyệt của bạn — các truy vấn API bên trong và lược đồ độc quyền ở lại riêng tư.
Tại Sao Định Dạng Tài Liệu GraphQL?
Các truy vấn GraphQL có thể trở nên phức tạp nhanh chóng — các mảnh lồng nhau, các biến nội tuyến, các định nghĩa hoạt động nhiều và định nghĩa loại SDL với giao diện và chỉ thị. Định dạng nhất quán làm cho đánh giá ngang hàng nhanh hơn và giúp dễ dàng phát hiện các dấu ngoặc đóng bị mất hoặc sự không khớp đối số trong một cái nhìn.
Trình định dạng sử dụng trình phân tích graphql.js tham chiếu — cùng một trình phân tích mà thông số kỹ thuật GraphQL được gửi. Điều đó có nghĩa là định dạng chính tắc bạn nhận được ở đây khớp những gì plugin GraphQL của Prettier và hầu hết các công cụ GraphQL tạo ra. Bất cứ điều gì phân tích sạch sẽ ở đây sẽ phân tích sạch sẽ trong Apollo, Relay và graphql-request.
Cách Định Dạng Tài Liệu GraphQL
- 01
Dán GraphQL của bạn
Dán một truy vấn, đột biến, đăng ký, mảnh hoặc định nghĩa lược đồ SDL vào bảng điều khiển đầu vào.
- 02
Nhấp vào Định Dạng
Trình phân tích phát hành tài liệu bằng thụt lề chính tắc — thụt lề hai dấu cách, một trường trên mỗi dòng, căn chỉnh đối số nhất quán. Kết quả xuất hiện trong bảng điều khiển đầu ra.
- 03
Xác thực tùy chọn
Nhấp vào Xác thực để xác nhận tài liệu phân tích mà không tạo ra đầu ra được định dạng. Kết quả là xác nhận hoặc danh sách các lỗi cú pháp có số dòng và cột.
- 04
Sao chép kết quả
Nhấp vào Sao chép để lấy tài liệu được định dạng. Dán nó vào cơ sở mã, mô tả PR hoặc tệp tài liệu của bạn.
An Toàn Cho Các Lược Đồ Bên Trong và Truy Vấn API
Trình phân tích graphql.js chạy hoàn toàn trong trình duyệt của bạn. Không có văn bản hoạt động hoặc định nghĩa lược đồ nào được gửi đến bất kỳ máy chủ nào. Điều đó làm cho nó an toàn để định dạng các truy vấn tham chiếu các tên trường riêng tư hoặc các hệ thống loại bên trong bạn không muốn tiết lộ cho các công cụ bên thứ ba.
Xác thực ở đây chỉ là cú pháp — công cụ kiểm tra rằng tài liệu là một tài liệu GraphQL hợp lệ, nhưng nó không kiểm tra xem tên trường có tồn tại trong lược đồ thực tế, liệu các biến có khớp với các loại đối số hoặc liệu các chỉ thị có được áp dụng chính xác không. Xác thực nhận thức lược đồ yêu cầu lược đồ mục tiêu được tải cùng với tài liệu.
Câu Hỏi Thường Gặp Về Trình Định Dạng GraphQL
Định dạng GraphQL có xác thực dựa trên lược đồ không?
Không — chỉ xác thực cú pháp. Kiểm tra xem các trường và đối số có tồn tại yêu cầu lược đồ mục tiêu. Công cụ này xác nhận tài liệu là một tài liệu GraphQL hợp lệ, không có gì hơn.
Bình luận trong GraphQL của tôi sẽ được bảo tồn không?
Không. Các dòng bắt đầu bằng # bị tước bởi trình phân tích. Sử dụng các chuỗi mô tả được trích dẫn ba lần cho tài liệu cần sống sót định dạng.
Phiên bản thông số kỹ thuật GraphQL nào được hỗ trợ?
Thông số kỹ thuật tháng 10 năm 2021, bao gồm các đối tượng đầu vào OneOf và chỉ thị @specifiedBy.
Tôi có thể định dạng định nghĩa lược đồ SDL, không phải chỉ tài liệu hoạt động không?
Có. Định nghĩa loại, khai báo giao diện, loại liên hiệp, enum, chỉ thị và mô tả đều round-trip chính xác thông qua trình định dạng.
Truy vấn hoặc lược đồ có được tải lên bất cứ nơi nào không?
Không. Trình phân tích graphql.js chạy hoàn toàn trong trình duyệt của bạn — không có gì rời khỏi thiết bị của bạn.