Scalar

Goal

ใช้งาน Scalar API Designer สำหรับออกแบบ ทดสอบ และจัดทำเอกสาร GraphQL APIs แบบครบวงจร

Scope

ใช้สำหรับการทำงานกับ Scalar ทุกประเภท เช่น ออกแบบ GraphQL APIs, ทดสอบ API, จัดทำเอกสาร API, สร้าง API reference, และทำงานร่วมกับทีม

Execute

• ทำความเข้าใจ GraphQL schema design
• เรียนรู้ Scalar interface และ features
• ศึกษา mock server capabilities
• ทำความเข้าใจ documentation generation
• ติดตั้ง Scalar CLI หรือ desktop app
• ตั้งค่า Scalar project
• เชื่อมต่อกับ Git repository
• ตั้งค่า integration กับ tools อื่นๆ
• ใช้ visual editor สำหรับ schema design
• ใช้ mock server สำหรับ testing
• ใช้ auto documentation สำหรับ docs
• ใช้ collaboration features สำหรับ teamwork
• จัดการ API versions อย่างเหมาะสม
• ทดสอบ APIs ด้วย built-in playground
• ตรวจสอบ schema validity
• deploy documentation
• monitor API usage

Rules

• ใช้ descriptive names สำหรับ types และ fields
• ใช้ consistent naming conventions
• ใช้ interfaces สำหรับ shared fields
• ใช้ enums สำหรับ fixed values
• ใช้ input types สำหรับ mutations
• ใช้ descriptions สำหรับทุก types และ fields
• ใช้ examples สำหรับ complex queries
• ใช้ deprecation warnings สำหรับ obsolete fields
• ใช้ custom directives สำหรับ metadata
• ให้ clear error messages
• ใช้ mock server สำหรับ development
• ทดสอบ queries และ mutations
• ทดสอบ error scenarios
• ทดสอบ performance
• ใช้ live playground สำหรับ interactive testing
• ใช้ version control สำหรับ schema changes
• ใช้ code review สำหรับ schema updates
• ใช้ branching strategy ที่เหมาะสม
• สื่อสาร changes อย่างชัดเจน
• ใช้ permissions อย่างเหมาะสม

Expected Outcome

• GraphQL APIs ที่ออกแบบอย่างเป็นระบบ
• Documentation ที่ครบถ้วนและอัตโนมัติ
• Mock server ที่ทำงานได้
• Collaboration ที่มีประสิทธิภาพ
• APIs ที่ผ่านการทดสอบแล้ว