การกำหนดค่า Schema
การกำหนดค่า Schemaการทำให้ API เป็นสาธารณะหรือส่วนตัว

การทำให้ API เป็นสาธารณะหรือส่วนตัว

ฟังก์ชันนี้ช่วยเสริมการควบคุมการเข้าถึง เพื่อให้มองเห็น schema ได้

เมื่อการเข้าถึงฟิลด์หรือ directive บางอย่างถูกปฏิเสธผ่านการควบคุมการเข้าถึง API มี 2 วิธีในการทำงาน:

โหมดสาธารณะ: ฟิลด์ใน schema จะถูกเปิดเผย และเมื่อสิทธิ์ไม่เป็นไปตามเงื่อนไข ผู้ใช้จะได้รับข้อความแสดงข้อผิดพลาดพร้อมคำอธิบายว่าเหตุใดสิทธิ์จึงถูกปฏิเสธ พฤติกรรมนี้ทำให้ metadata จาก schema พร้อมใช้งานเสมอ

โหมดส่วนตัว: schema จะถูกปรับแต่งให้กับผู้ใช้แต่ละคน โดยมีเฉพาะฟิลด์ที่ผู้ใช้นั้นสามารถเข้าถึงได้ ดังนั้นเมื่อพยายามเข้าถึงฟิลด์ที่ถูกห้าม ข้อความแสดงข้อผิดพลาดจะระบุว่าฟิลด์นั้นไม่มีอยู่ พฤติกรรมนี้เปิดเผย metadata จาก schema เฉพาะกับผู้ใช้ที่สามารถเข้าถึงได้เท่านั้น

วิธีกำหนดการมองเห็นของ API

มี 3 ระดับที่เราสามารถกำหนดการมองเห็นของ API ว่าเป็นสาธารณะหรือส่วนตัว เรียงตามลำดับความสำคัญ:

1. กำหนดแยกกันในแต่ละฟิลด์และ directive

ตัวเลือกนี้จะใช้งานได้เมื่อตัวเลือก "Enable granular control?" ในการตั้งค่าเป็น on

เราสามารถกำหนดการมองเห็นสำหรับชุดฟิลด์และ directive ได้เมื่อแก้ไข entry จากรายการควบคุมการเข้าถึง:

โหมด schema สาธารณะ/ส่วนตัวแบบรายบุคคล

2. ในการกำหนดค่า schema

เราสามารถกำหนดการมองเห็นในการกำหนดค่า schema เพื่อนำไปใช้กับ custom endpoint หรือ persisted query ทั้งหมด:

โหมด schema สาธารณะ/ส่วนตัว ตั้งค่าในการกำหนดค่า Schema
โหมด schema สาธารณะ/ส่วนตัว ตั้งค่าในการกำหนดค่า Schema

3. โหมดเริ่มต้น กำหนดในการตั้งค่า

หากการกำหนดค่า schema มีค่าเป็น "Default" จะใช้โหมดที่กำหนดไว้ในการตั้งค่า:

โหมด schema สาธารณะ/ส่วนตัวเริ่มต้น
โหมด schema สาธารณะ/ส่วนตัวเริ่มต้น