ประเด็นสำคัญ
- 01จัดรูปแบบ queries, mutations, subscriptions และ SDL schemas โดยใช้ official graphql.js parser
- 02Validate syntax และรายงาน exact line และ column สำหรับข้อผิดพลาด — ไม่จำเป็นต้องมี schema
- 03GraphQL comments (#) ถูกลบบนการจัดรูปแบบ ใช้ description strings สำหรับเอกสารที่คุณต้องการรักษา
- 04ทำงานทั้งหมดในเบราว์เซอร์ของคุณ — internal API queries และ proprietary schemas ยังคงเป็นส่วนตัว
เหตุใดจึงควรจัดรูปแบบ GraphQL Documents?
GraphQL queries สามารถซับซ้อนได้อย่างรวดเร็ว — nested fragments, inline variables, multiple operation definitions และ SDL type definitions พร้อม interfaces และ directives การจัดรูปแบบที่สอดคล้องทำให้ peer review เร็วขึ้นและทำให้มองเห็นวงเล็บปิดที่หายไปหรือ argument mismatches ได้ในตอนแรก
ตัวจัดรูปแบบใช้ reference graphql.js parser — parser เดียวกับที่ GraphQL specification มาพร้อม นั่นหมายถึง canonical formatting ที่คุณได้รับที่นี่ตรงกับสิ่งที่ Prettier's GraphQL plugin และ GraphQL tooling ส่วนใหญ่สร้าง สิ่งใด parse ได้สะอาดที่นี่จะ parse สะอาดใน Apollo, Relay และ graphql-request
วิธีจัดรูปแบบ GraphQL Document
- 01
วาง GraphQL ของคุณ
วาง query, mutation, subscription, fragment หรือ SDL schema definition ลงในแผงป้อนข้อมูล
- 02
คลิกจัดรูปแบบ
ตัว parser ส่งออก document พร้อม canonical indentation — two-space indent, one field ต่อบรรทัด, consistent argument alignment ผลลัพธ์ปรากฏในแผงผลลัพธ์
- 03
Validate ตามต้องการ
คลิก Validate เพื่อยืนยัน document parses โดยไม่สร้างผลลัพธ์ที่จัดรูปแบบ ผลลัพธ์คือการยืนยันหรือรายการ syntax errors พร้อมบรรทัดและ column numbers
- 04
คัดลอกผลลัพธ์
คลิกคัดลอกเพื่อรับ document ที่จัดรูปแบบ วางลงในฐานรหัส คำอธิบาย PR หรือไฟล์เอกสาร
ปลอดภัยสำหรับ Internal Schemas และ API Queries
graphql.js parser ทำงานทั้งหมดในเบราว์เซอร์ของคุณ ไม่มีการส่งข้อความการดำเนินการหรือ schema definition ไปยังเซิร์ฟเวอร์ใดๆ ซึ่งทำให้ปลอดภัยในการจัดรูปแบบ queries ที่อ้างอิงชื่อฟิลด์ส่วนตัวหรือ internal type systems ที่คุณไม่ต้องการเปิดเผยต่อเครื่องมือของบริษัทที่สาม
Validation ที่นี่เป็นไวยากรณ์เท่านั้น — เครื่องมือตรวจสอบว่า document เป็น GraphQL document ที่ถูกต้องหรือไม่ แต่ไม่ได้ตรวจสอบว่าชื่อฟิลด์มีอยู่ใน real schema, variables จับคู่ argument types หรือ directives ถูกนำไปใช้อย่างถูกต้องหรือไม่ Schema-aware validation ต้องให้ target schema โหลดข้างๆ document
GraphQL Formatter FAQ
การจัดรูปแบบ GraphQL ตรวจสอบเทียบกับ schema หรือไม่?
ไม่ — เพียง syntax validation นอก การตรวจสอบว่าฟิลด์และ arguments มีอยู่ต้องมี target schema ซึ่งเครื่องมือนี้ยืนยันว่า document เป็น GraphQL document ที่ถูกต้องเท่านั้น
Comments ใน GraphQL ของฉันจะรักษาไว้หรือไม่?
ไม่ Lines เริ่มต้นด้วย # ถูกลบโดย parser ใช้ triple-quoted description strings สำหรับ documentation ที่ควรอยู่รอด formatting
GraphQL spec version ใดได้รับการรองรับ?
October 2021 specification รวมถึง OneOf input objects และ @specifiedBy directive
ฉันสามารถจัดรูปแบบ SDL schema definitions ไม่ใช่เพียง operation documents?
ใช่ Type definitions, interface declarations, union types, enums, directives และ descriptions ทั้งหมด round-trip ถูกต้องผ่าน formatter
Query หรือ schema ถูกอัปโหลดไปที่ใดหรือไม่?
ไม่ graphql.js parser ทำงานทั้งหมดในเบราว์เซอร์ของคุณ — ไม่มีสิ่งใดออกจากอุปกรณ์ของคุณ