GraphQL clients
รวบรวมและแนะนำภาพรวมของ clients ที่ได้รับความนิยมสูงสุดสำหรับการโต้ตอบกับ GraphQL
GraphiQL
GraphiQL คือ IDE สำหรับการรัน GraphQL queries โดยเฉพาะ เปิดตัวพร้อมกับ GraphQL ตั้งแต่แรก ทำให้เห็นได้ชัดเจนทันทีว่า GraphQL สามารถมอบประสบการณ์การพัฒนาที่เหนือกว่า API ที่มีอยู่เดิมได้อย่างไร ด้วยการรวม client สำหรับรัน queries กับ GraphQL server และ explorer สำหรับเรียกดูเอกสารของ schema ไว้ในที่เดียวกัน
GraphiQL มอบฟีเจอร์ต่าง ๆ ดังต่อไปนี้ (และอีกมาก):
- Tabs
- Custom headers
- Syntax highlighting
- การแนะนำ type อัจฉริยะสำหรับ fields, arguments, types และอื่น ๆ
- การไฮไลต์และรายงานข้อผิดพลาดแบบ real-time สำหรับ queries และตัวแปร
- การเติม queries และตัวแปรให้สมบูรณ์โดยอัตโนมัติ
- การเพิ่ม required fields เข้า queries โดยอัตโนมัติ
- Documentation explorer พร้อมฟังก์ชันค้นหาและรองรับ Markdown
- ประวัติ queries โดยใช้ local storage
- Themes
มี demo ให้ใช้งานที่ graphql.org/swapi-graphql เขียน GraphQL query ด้วยความช่วยเหลือของ editor กด "Execute Query" ที่อยู่ตรงกลางระหว่างสอง pane แล้วดูผลลัพธ์ของ query
Voyager
GraphQL Voyager คือ schema visualizer แบบโต้ตอบที่เป็นตัวแทนของประเภทนี้ แสดงให้เห็น (ตามที่ระบุในเอกสารของพวกเขา) "กราฟที่อยู่เบื้องหลัง GraphQL"
มีฟีเจอร์ดังต่อไปนี้:
- การนำทางอย่างรวดเร็วบนกราฟ
- แผงด้านซ้ายที่ให้ข้อมูลรายละเอียดเพิ่มเติมเกี่ยวกับแต่ละ type
- ตัวเลือก "Skip Relay" ที่ทำให้กราฟเรียบง่ายขึ้นด้วยการลบ Relay wrapper classes ออก
- ความสามารถในการเลือก type ใด ๆ เป็น root ของกราฟ
มี live demo ที่ ivangoncharov.github.io/graphql-voyager
DociQL
DociQL มีคำสั่งสำหรับสร้างเอกสาร HTML5 แบบ static ที่สวยงามจาก GraphQL endpoint หลังจากรันคำสั่งแล้ว ผลลัพธ์จะเป็น directory ที่มีไฟล์ HTML, CSS และ JS ซึ่งเราต้องคัดลอกไปยัง webserver เพื่อแสดงเอกสารของ GraphQL schema
เอกสารที่สร้างขึ้น โดยค่าเริ่มต้นจะแสดงเลย์เอาต์หน้าเดียวแบบ 3 คอลัมน์ โดยมีลิงก์ไปยัง types ทั้งหมดในคอลัมน์ซ้าย คำอธิบายตรงกลาง และตัวอย่าง query ทางขวา:
มีฟีเจอร์ดังต่อไปนี้:
- ใช้ introspection query เพื่อดึง schema ของ GraphQL และสร้างเอกสารแบบ on-the-fly
- สร้างตัวอย่าง request และ response พร้อมลิงก์ "Try it now"
- ให้ผู้ใช้กำหนด use cases และจัดกลุ่มตาม domain ได้
- ปรับแต่งได้ผ่าน Handlebars templates และ SCSS styles
- รองรับ Markdown ภายในคำอธิบาย API
- เลย์เอาต์ HTML5 และ CSS3 แบบ responsive ที่ทำงานได้กับทุกอุปกรณ์และขนาดหน้าจอ
- เอกสารบางส่วนที่ฝังได้ภายในเว็บไซต์ที่มีอยู่แล้ว
มี demo สำหรับเอกสารที่สร้างขึ้นที่ wayfair.github.io/dociql
SpectaQL
SpectaQL สร้างต่อยอดจาก DociQL เพื่อปรับให้เหมาะสมกับ GraphQL มากขึ้น โดยมี theme ที่แสดงเฉพาะข้อมูลที่เกี่ยวข้องกับ GraphQL ตัดเนื้อหาจากโดเมน Swagger/OpenAPI ออก (ตัวอย่างเช่น ละทิ้งข้อความ "Response Content-Types: application/json" และ "Response Example (200 OK)" ที่แสดงในตัวอย่าง query)
SpectaQL ยังอนุญาตให้ป้อน GraphQL schema source ได้หลายวิธี:
- จาก live endpoint โดยใช้ introspection query
- จากไฟล์ที่มีผลลัพธ์ของ introspection query
- จากไฟล์ หลายไฟล์ หรือ glob ที่นำไปสู่คำจำกัดความของ schema ใน SDL
มี demo ของเอกสารที่สร้างขึ้นที่ useanvil.com/docs/api/graphql/reference
Postman
Postman คือแพลตฟอร์ม API สำหรับสร้างและใช้งาน APIs แม้จะไม่ได้สร้างมาเพื่อ GraphQL โดยเฉพาะ แต่ Postman ก็สามารถใช้รัน GraphQL queries และเพิ่มประสิทธิภาพการทำงานร่วมกันในการสร้าง GraphQL APIs ได้
Postman มีเครื่องมือที่ช่วยเร่ง API lifecycle รวมถึงการออกแบบ การทดสอบ เอกสาร และการทำ mock ของ APIs และเราสามารถจัดระเบียบ APIs ผ่าน workspaces เพื่อทำงานร่วมกับสมาชิกทีมที่กระจายอยู่ทั่วโลก
Altair
Altair เป็น GraphQL Client IDE อีกตัวหนึ่ง คล้ายกับ Postman แต่เฉพาะสำหรับ GraphQL
นอกจากฟีเจอร์ทั้งหมดที่ GraphQL client IDE ทั่วไปมีให้แล้ว Altair ยังมี environments เพื่อให้สามารถสลับระหว่างการใช้ APIs สำหรับ local, staging และ production environments และ query collections เพื่อแชร์กับสมาชิกทีมได้ง่าย