Các client GraphQL
Đây là tổng hợp và tổng quan về một số client phổ biến nhất để tương tác với GraphQL.
GraphiQL
GraphiQL là IDE hàng đầu để thực thi các GraphQL queries. Ban đầu được phát hành cùng với GraphQL, nó đã làm rõ ngay lập tức rằng GraphQL có thể mang lại trải nghiệm phát triển vượt trội so với các API hiện có, bằng cách kết hợp trong một nơi duy nhất cả client để thực thi queries đối với máy chủ GraphQL lẫn explorer để duyệt tài liệu schema.
Trong số các tính năng khác, GraphiQL cung cấp:
- Tabs
- Header tùy chỉnh
- Tô sáng cú pháp
- Gợi ý thông minh cho các trường, tham số, kiểu dữ liệu và nhiều hơn nữa
- Tô sáng và báo cáo lỗi theo thời gian thực cho queries và biến
- Tự động hoàn thành queries và biến
- Tự động thêm các trường bắt buộc vào queries
- Trình khám phá tài liệu, tìm kiếm, có hỗ trợ Markdown
- Lịch sử queries sử dụng bộ nhớ cục bộ
- Giao diện
Có một bản demo tại graphql.org/swapi-graphql. Soạn một GraphQL query với sự hỗ trợ của trình soạn thảo, nhấn nút "Execute Query" ở giữa hai ngăn, và xem phản hồi của query.
Voyager
GraphQL Voyager là công cụ trực quan hóa schema tương tác đặc trưng nhất, hiển thị (như họ đề cập trong tài liệu) "đồ thị đằng sau GraphQL".
Nó đi kèm với các tính năng sau:
- Điều hướng nhanh trên đồ thị.
- Bảng điều khiển bên trái cung cấp thông tin chi tiết hơn về từng kiểu.
- Tùy chọn "Skip Relay" giúp đơn giản hóa đồ thị bằng cách loại bỏ các lớp wrapper của Relay.
- Khả năng chọn bất kỳ kiểu nào làm gốc của đồ thị.
Có một bản demo trực tiếp tại ivangoncharov.github.io/graphql-voyager.
DociQL
DociQL cung cấp lệnh để tạo tài liệu HTML5 tĩnh đẹp mắt từ một GraphQL endpoint. Sau khi chạy lệnh, kết quả sẽ là một thư mục bao gồm các tệp HTML, CSS và JS mà chúng ta phải sao chép lên máy chủ web để hiển thị tài liệu cho schema GraphQL của mình.
Tài liệu được tạo ra, theo mặc định, hiển thị bố cục một trang với 3 cột, với các liên kết đến tất cả các kiểu ở cột bên trái, mô tả ở giữa và ví dụ query ở bên phải:
Nó đi kèm với các tính năng sau:
- Sử dụng introspection query để lấy schema GraphQL và tạo tài liệu ngay lập tức.
- Tạo ví dụ yêu cầu và phản hồi với các liên kết "Try it now".
- Cho phép người dùng xác định các trường hợp sử dụng và nhóm chúng theo lĩnh vực.
- Có thể cấu hình qua template Handlebars và kiểu SCSS.
- Hỗ trợ Markdown trong các mô tả API.
- Bố cục HTML5 và CSS3 đáp ứng, hoạt động trên mọi thiết bị và kích thước màn hình.
- Tài liệu một phần, có thể nhúng vào một trang web hiện có.
Có một bản demo cho tài liệu được tạo ra tại wayfair.github.io/dociql.
SpectaQL
SpectaQL xây dựng trên DociQL để thích nghi tốt hơn với GraphQL. Nó cung cấp một theme chỉ hiển thị thông tin liên quan đến GraphQL, loại bỏ nội dung từ miền Swagger/OpenAPI (ví dụ, nó loại bỏ các thông báo "Response Content-Types: application/json" và "Response Example (200 OK)" được hiển thị trong ví dụ query).
SpectaQL cũng cho phép nhập nguồn schema GraphQL bằng nhiều tùy chọn:
- Từ một endpoint trực tiếp sử dụng introspection query.
- Từ một tệp chứa kết quả của introspection query.
- Từ một tệp, nhiều tệp hoặc glob dẫn đến các định nghĩa schema trong SDL.
Có một bản demo của tài liệu được tạo ra tại useanvil.com/docs/api/graphql/reference.
Postman
Postman là nền tảng API để xây dựng và sử dụng các API. Mặc dù không được xây dựng đặc biệt cho GraphQL, Postman có thể được sử dụng để thực thi các GraphQL queries và hợp lý hóa sự cộng tác để tạo ra các API GraphQL.
Postman bao gồm các công cụ giúp tăng tốc vòng đời API, bao gồm thiết kế, kiểm thử, tài liệu và mô phỏng các API. Chúng ta có thể tổ chức các API thông qua các workspace để cộng tác với các thành viên trong nhóm trên khắp thế giới.
Altair
Altair là một GraphQL Client IDE khác, tương tự Postman nhưng dành riêng cho GraphQL.
Ngoài tất cả các tính năng mà mọi GraphQL client IDE cung cấp, Altair còn cung cấp các môi trường, để chúng ta có thể chuyển đổi giữa việc sử dụng API cho môi trường cục bộ, staging và production, cùng với các bộ sưu tập queries để dễ dàng chia sẻ với các thành viên trong nhóm.