Đánh dấu trường đã lỗi thời
Quản lý phiên bản schema GraphQL liên quan đến việc đánh dấu các trường là lỗi thời, tức là thông báo cho người dùng rằng trường đó không nên được sử dụng nữa và nên thay thế bằng trường nào khác.
Ngoài việc đánh dấu các trường là lỗi thời thông qua mã nguồn, Gato GraphQL còn cung cấp giao diện người dùng để cấu hình những trường nào cần đánh dấu lỗi thời và cách thực hiện.
Cấu hình được tạo thông qua danh sách đánh dấu trường lỗi thời, và được cung cấp cho các custom endpoint và persisted queries thông qua cấu hình schema.
Truy cập tất cả danh sách đánh dấu trường lỗi thời
Nhấp vào "Field Deprecation Lists" trong menu của plugin, danh sách tất cả các danh sách đánh dấu trường lỗi thời đã tạo sẽ được hiển thị:
Tạo danh sách đánh dấu trường lỗi thời mới
Nhấp vào nút "Add New Field Deprecation List" để mở trình soạn thảo WordPress:
Đặt tiêu đề cho danh sách đánh dấu trường lỗi thời, thêm các mục với các trường, và cấu hình thông báo lỗi thời. Khi hoàn tất, nhấp vào nút Publish. Sau đó, danh sách đánh dấu trường lỗi thời mới sẽ có sẵn cho cấu hình schema.
Trường sẽ được đánh dấu là lỗi thời trong schema và, ngoài ra, thông báo lỗi thời sẽ được hiển thị trong phản hồi khi thực hiện queries trên một trường đã lỗi thời (nếu module Deprecation Notifier được bật).
Các mục đánh dấu trường lỗi thời
Mỗi Field Deprecation List chứa một hoặc nhiều mục, mỗi mục có các yếu tố sau:
- Các trường cần đánh dấu lỗi thời
- Thông báo lỗi thời
Chọn trường từ các interface
Ngoài các trường từ các kiểu dữ liệu, chúng ta cũng có thể chọn các trường từ các interface. Trong trường hợp này, việc đánh dấu lỗi thời được áp dụng cho các trường đó trên tất cả các kiểu dữ liệu triển khai interface.
Mô tả danh sách đánh dấu trường lỗi thời
Sử dụng trường "Excerpt" trong bảng Document settings để cung cấp mô tả cho danh sách đánh dấu trường lỗi thời.
Tìm thêm thông tin trong hướng dẫn Thêm mô tả cho API.
Sử dụng danh sách đánh dấu trường lỗi thời
Sau khi tạo danh sách đánh dấu trường lỗi thời, chúng ta có thể cho Custom Endpoint hoặc Persisted Query sử dụng nó bằng cách chỉnh sửa Schema Configuration tương ứng, và chọn ACL từ danh sách trong block "Field Deprecation Lists".
Nếu không tùy chỉnh cấu hình, các Field Deprecation Lists mặc định được xác định trên trang Cài đặt, trong tab "Field Deprecation", sẽ được sử dụng:
