การกำหนดค่า Schema
การกำหนดค่า Schemaการเลิกใช้งานฟิลด์

การเลิกใช้งานฟิลด์

การกำหนดเวอร์ชันของ GraphQL schema เกี่ยวข้องกับการเลิกใช้งานฟิลด์ กล่าวคือ การแจ้งให้ผู้ใช้ทราบว่าไม่ควรใช้ฟิลด์นั้นอีกต่อไป และควรใช้ฟิลด์ใดแทน

นอกจากการเลิกใช้งานฟิลด์ผ่านโค้ดแล้ว Gato GraphQL ยังมีอินเทอร์เฟซผู้ใช้สำหรับกำหนดค่าว่าจะเลิกใช้งานฟิลด์ใดและอย่างไร

การกำหนดค่าจะสร้างขึ้นผ่านรายการการเลิกใช้งานฟิลด์ และส่งมอบไปยัง custom endpoints และ persisted queries ผ่านการกำหนดค่า schema

การเข้าถึงรายการการเลิกใช้งานฟิลด์ทั้งหมด

คลิกที่ "Field Deprecation Lists" ในเมนูของปลั๊กอิน จะแสดงรายการของรายการการเลิกใช้งานฟิลด์ทั้งหมดที่สร้างขึ้น:

Field Deprecation Lists ในหน้าผู้ดูแลระบบ
Field Deprecation Lists ในหน้าผู้ดูแลระบบ

การสร้างรายการการเลิกใช้งานฟิลด์ใหม่

คลิกที่ปุ่ม "Add New Field Deprecation List" เพื่อเปิด WordPress editor:

การสร้าง Field Deprecation List

ตั้งชื่อรายการการเลิกใช้งานฟิลด์ เพิ่มรายการที่มีฟิลด์ และกำหนดค่าข้อความการเลิกใช้งาน เมื่อพร้อมแล้ว คลิกที่ปุ่ม Publish จากนั้นรายการการเลิกใช้งานฟิลด์ใหม่จะพร้อมใช้งานในการกำหนดค่า schema

ฟิลด์จะถูกทำเครื่องหมายว่าเลิกใช้งานใน schema และนอกจากนี้ ข้อความการเลิกใช้งานจะแสดงในการตอบสนองเมื่อ queries ฟิลด์ที่เลิกใช้งาน (หากเปิดใช้งานโมดูล Deprecation Notifier)

รายการการเลิกใช้งานฟิลด์

Field Deprecation List แต่ละรายการประกอบด้วยรายการหนึ่งรายการหรือมากกว่า โดยแต่ละรายการมีองค์ประกอบดังต่อไปนี้:

  • ฟิลด์ที่จะเลิกใช้งาน
  • ข้อความการเลิกใช้งาน

รายการการควบคุมการเข้าถึง

การเลือกฟิลด์จาก interfaces

นอกจากฟิลด์จาก types แล้ว เรายังสามารถเลือกฟิลด์จาก interfaces ได้ด้วย ในกรณีนี้ การเลิกใช้งานจะถูกดำเนินการกับฟิลด์เหล่านั้นจาก types ทั้งหมดที่ใช้งาน interface ดังกล่าว

การเลือกฟิลด์จาก interface
การเลือกฟิลด์จาก interface

การอธิบายรายการการเลิกใช้งานฟิลด์

ใช้ฟิลด์ "Excerpt" จากแผงการตั้งค่า Document เพื่อเพิ่มคำอธิบายให้กับรายการการเลิกใช้งานฟิลด์

ดูข้อมูลเพิ่มเติมได้ในคู่มือ การเพิ่มคำอธิบายให้กับ API

การใช้งานรายการการเลิกใช้งานฟิลด์

หลังจากสร้างรายการการเลิกใช้งานฟิลด์แล้ว เราสามารถให้ Custom Endpoint หรือ Persisted Query ใช้งานมันได้โดยการแก้ไขการกำหนดค่า Schema ที่เกี่ยวข้อง และเลือก ACL จากรายการภายใต้บล็อก "Field Deprecation Lists"

การเลือก Field Deprecation List ใน Schema Configuration

หากไม่ได้กำหนดค่าการกำหนดค่าเอง Field Deprecation Lists เริ่มต้นที่กำหนดไว้ในหน้าการตั้งค่า ภายใต้แท็บ "Field Deprecation" จะถูกนำมาใช้:

การเลือก Field Deprecation Lists เริ่มต้นในหน้าการตั้งค่า