วิธีตั้งค่า Enumeration สำหรับฟิลด์ใน Apidog (String, Array, อื่นๆ)

สวัสดีครับ! หากคุณกำลังเจาะลึกการออกแบบ API ด้วย Apidog และต้องการทำให้ส่วนต่อประสานของคุณชัดเจนที่สุด การตั้งค่าการแจงนับ (enumerations หรือ enums) เป็นสิ่งจำเป็นอย่างยิ่ง Enums ช่วยให้คุณกำหนดชุดค่าที่แน่นอนสำหรับฟิลด์ เช่น “active,” “frozen,” หรือ “deleted” สำหรับสถานะผู้ใช้ เพื่อให้แน่ใจว่านักพัฒนาจะเลือกได้จากตัวเลือกเหล่านั้นเท่านั้น สิ่งนี้ช่วยป้องกันข้อผิดพลาดที่น่ารำคาญและทำให้เอกสาร API ของคุณคมชัด ในคู่มือสนทนานี้ เราจะสำรวจวิธีการตั้งค่าการแจงนับสำหรับสตริง, อาร์เรย์ และอื่นๆ ใน Apidog โดยใช้ UI ที่ใช้งานง่ายและคุณสมบัติที่ขับเคลื่อนด้วย AI ไม่ว่าคุณจะเป็นมือใหม่หรือนักพัฒนาที่มีประสบการณ์ คุณจะสามารถตั้งค่าการแจงนับของ Apidog ได้อย่างมืออาชีพในเวลาอันรวดเร็ว มาเริ่มกันเลย!

ทำไมต้องใช้การแจงนับใน Apidog?

การแจงนับเปรียบเสมือนรั้วกั้นสำหรับฟิลด์ API ของคุณ ลองนึกภาพฟิลด์ “สถานะผู้ใช้” ที่มีเพียง “active,” “frozen,” หรือ “deleted” เท่านั้นที่ถูกต้อง หากไม่มี enum นักพัฒนาอาจส่งค่า “inactive” หรือ “banned” โดยไม่ตั้งใจ ทำให้ API ของคุณมีปัญหาได้ ด้วยการตั้งค่า การแจงนับของ Apidog คุณจะสามารถระบุค่าที่อนุญาตได้อย่างชัดเจน ทำให้เอกสารของคุณชัดเจนและลดข้อผิดพลาด นอกจากนี้ คุณสมบัติ Mock data ของ Apidog ยังเคารพ enum เหล่านี้โดยอัตโนมัติ สร้างข้อมูลทดสอบที่ยึดตามกฎของคุณ ไม่ว่าจะเป็นสตริงเช่น “pending” หรืออาร์เรย์ของสิทธิ์เฉพาะ enums ช่วยให้การทำงานร่วมกันราบรื่นและทำให้ API ของคุณแข็งแกร่ง

Apidog ซึ่งเป็นแพลตฟอร์มที่มีประสิทธิภาพสำหรับการออกแบบ, ดีบัก และทดสอบ API รองรับ enums สำหรับประเภทข้อมูลต่างๆ รวมถึงสตริง, จำนวนเต็ม, ตัวเลข และอาร์เรย์ คุณยังสามารถเพิ่มคำอธิบายให้กับแต่ละค่าเพื่อความชัดเจนยิ่งขึ้น มาดูวิธีการตั้งค่ากัน ตั้งแต่สตริงพื้นฐานไปจนถึงอาร์เรย์ที่ซับซ้อน และสำรวจว่า AI และโมเดลที่นำกลับมาใช้ใหม่ได้จะทำให้ชีวิตของคุณง่ายขึ้นได้อย่างไร

การตั้งค่าการแจงนับพื้นฐานใน Apidog

มาเริ่มจากกรณีที่ง่ายที่สุด: การตั้งค่าการแจงนับสำหรับฟิลด์สตริงหรือตัวเลข เช่น สถานะผู้ใช้หรือสถานะคำสั่งซื้อ มีวิธีทำดังนี้:

1. เปิด Interface Editor:

• ใน Apidog ให้ไปที่โปรเจกต์ของคุณและเปิดอินเทอร์เฟซ (endpoint) ที่คุณกำลังทำงานอยู่ ค้นหาฟิลด์ที่คุณต้องการจำกัด เช่น user_status ในส่วนเนื้อหาของคำขอหรือการตอบกลับ

2. เลือกประเภทข้อมูล:

• ในการตั้งค่าฟิลด์ ให้เลือกประเภทข้อมูลจากเมนูดรอปดาวน์ ซึ่งโดยทั่วไปคือ string (เช่น สำหรับ “active”), integer หรือ number ตัวอย่างเช่น เลือก string สำหรับ user_status

3. เข้าถึงการตั้งค่าขั้นสูง:

• คลิกปุ่ม **Advanced Settings** ถัดจากประเภทฟิลด์ ซึ่งจะเปิดแผงที่คุณสามารถกำหนดค่า enum ได้

4. เพิ่มค่าการแจงนับ:

• ในส่วน **Enumeration Values** ให้ป้อนค่าที่อนุญาตของคุณ ทีละบรรทัด สำหรับ user_status คุณอาจเพิ่ม:
• active (คำอธิบาย: “ผู้ใช้ใช้งานอยู่และสามารถเข้าสู่ระบบได้”)
• frozen (คำอธิบาย: “บัญชีผู้ใช้ถูกระงับชั่วคราว”)
• deleted (คำอธิบาย: “บัญชีผู้ใช้ถูกลบอย่างถาวร”)
• คุณสามารถเพิ่มคำอธิบายสำหรับแต่ละค่าเพื่อทำให้เอกสารชัดเจนยิ่งขึ้นได้

5. บันทึกและตรวจสอบเอกสาร:

• บันทึกการเปลี่ยนแปลงของคุณ ในเอกสาร API, Apidog จะแสดงค่าเหล่านี้เป็นตัวเลือกที่ถูกต้องเพียงอย่างเดียวสำหรับฟิลด์ สมาชิกในทีมจะเห็นข้อความประมาณว่า: “user_status: ต้องเป็นหนึ่งใน [active, frozen, deleted]”

เมื่อดีบักใน Apidog คุณสามารถเลือกค่า enum เหล่านี้ได้โดยตรงจากดรอปดาวน์ เพื่อให้แน่ใจว่าคำขอทดสอบของคุณถูกต้อง เป็นวิธีง่ายๆ ในการทำให้ทุกคนเข้าใจตรงกัน!

เคล็ดลับมือโปร: ใช้คุณสมบัติ **Bulk Edit** ในแผง enum เพื่อวางค่าหลายค่าพร้อมกัน ช่วยประหยัดเวลาสำหรับรายการที่ยาว

การจัดการการแจงนับอาร์เรย์ใน Apidog

การแจงนับอาร์เรย์นั้นซับซ้อนขึ้นเล็กน้อยแต่มีประโยชน์อย่างยิ่งสำหรับฟิลด์ต่างๆ เช่น สิทธิ์ผู้ใช้หรือพิกัด Apidog รองรับ enum อาร์เรย์สองประเภท: การจำกัดองค์ประกอบอาร์เรย์แต่ละรายการ หรือการจำกัดอาร์เรย์ทั้งหมดให้เป็นชุดค่าผสมเฉพาะ มาดูกันทีละส่วน

สถานการณ์ที่ 1: การจำกัดค่าองค์ประกอบอาร์เรย์

สมมติว่าคุณมีฟิลด์ permissions ซึ่งเป็นอาร์เรย์ของสตริง โดยที่แต่ละสตริงต้องเป็นหนึ่งใน “read,” “write,” หรือ “delete” อาร์เรย์ที่ถูกต้องอาจเป็น ["read"], ["write", "delete"], หรือ ["read", "write", "delete"] นี่คือวิธีการตั้งค่า:

1. ตั้งค่าฟิลด์เป็นประเภทอาร์เรย์:

• ใน interface editor ให้ตั้งค่าฟิลด์ (เช่น permissions) เป็นประเภท array

2. กำหนดค่าประเภทองค์ประกอบย่อย:

• ภายใต้การตั้งค่าอาร์เรย์ คุณจะเห็นตัวเลือก **Sub-Element Type** เลือก string (หรือประเภทอื่น เช่น integer)

3. เพิ่มค่า Enum:

• คลิก **Advanced Settings** สำหรับองค์ประกอบย่อย ในส่วน **Enumeration Values** ให้เพิ่ม:
• read (คำอธิบาย: “สิทธิ์อ่านเท่านั้น”)
• write (คำอธิบาย: “สิทธิ์เขียน”)
• delete (คำอธิบาย: “สิทธิ์ลบ”)

4. ทางเลือก: บังคับให้เป็นค่าที่ไม่ซ้ำกัน:

• ในการตั้งค่าขั้นสูงของอาร์เรย์ ให้เปิดใช้งาน **All Elements Must Be Unique** เพื่อป้องกันค่าซ้ำ (เช่น ["read", "read"] จะไม่ถูกต้อง)

5. บันทึกและทดสอบ:

• บันทึก แล้วเอกสารจะแสดงว่าองค์ประกอบของอาร์เรย์ถูกจำกัดไว้ที่ค่าเหล่านี้ Mock data จะสร้างอาร์เรย์เช่น ["read", "write"] โดยเคารพกฎของ enum และการไม่ซ้ำกัน

อีกทางเลือกหนึ่ง คุณสามารถแก้ไข JSON Schema ด้วยตนเองในแท็บ **Advanced Settings**:

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": ["read", "write", "delete"]
  },
  "uniqueItems": true
}

สิ่งนี้ทำให้แน่ใจว่าทุกองค์ประกอบในอาร์เรย์เป็นไปตาม enum

สถานการณ์ที่ 2: การจำกัดค่าอาร์เรย์ทั้งหมด

บางครั้ง คุณต้องการให้อาร์เรย์ทั้งหมดเป็นหนึ่งในชุดค่าผสมที่กำหนดไว้ไม่กี่ชุด เช่น ฟิลด์ coordinate ที่สามารถเป็นได้แค่ [0, 0] หรือ [100, 100] นี่คือวิธีการ:

1. ตั้งค่าฟิลด์เป็นประเภทอาร์เรย์:

• เลือก array สำหรับฟิลด์ (เช่น coordinate)

2. แก้ไข JSON Schema:

• ใน **Advanced Settings** ให้สลับไปที่ตัวแก้ไข JSON Schema และป้อน:

{
  "type": "array",
  "enum": [
    [0, 0],
    [100, 100]
  ]
}

• สิ่งนี้จะจำกัดฟิลด์ให้เป็นอาร์เรย์เหล่านี้เท่านั้น—ไม่อนุญาตชุดค่าผสมอื่นใด เช่น [0, 100]

3. บันทึกและตรวจสอบ:

• บันทึก แล้วเอกสารจะแสดง [0, 0] และ [100, 100] เป็นค่าที่ถูกต้องเพียงอย่างเดียว Mock data จะสุ่มเลือกหนึ่งในอาร์เรย์เหล่านี้

วิธีนี้ไม่ค่อยพบเห็นบ่อยนัก แต่มีประสิทธิภาพสำหรับกรณีการใช้งานเฉพาะ เช่น การตั้งค่าที่กำหนดไว้ล่วงหน้า หรือโครงสร้างข้อมูลที่ตายตัว

การใช้ AI เพื่อลดความซับซ้อนในการตั้งค่าการแจงนับ

การเขียน JSON Schema สำหรับ enum ที่ซับซ้อน โดยเฉพาะอย่างยิ่งอาร์เรย์ อาจรู้สึกเหมือนกำลังต่อสู้กับไวยากรณ์ โชคดีที่ฟีเจอร์ AI ของ **Apidog** พร้อมที่จะช่วยคุณ! มันช่วยให้คุณอธิบายความต้องการ enum ของคุณด้วยภาษาธรรมดา และมันจะสร้างการกำหนดค่าที่ถูกต้องให้

1. เปิดใช้งาน AI ใน Apidog:

• ไปที่ **Team Settings** > **AI Features** และเปิดใช้งาน AI assistance ตรวจสอบเอกสารช่วยเหลือของ Apidog สำหรับรายละเอียด

2. อธิบายความต้องการของคุณ:

• ใน interface editor ให้เปิดแผงแชท AI และพิมพ์บางอย่างเช่น:

coordinate[1, 2][3, 4]

• หรือสำหรับสตริง: “จำกัด status ให้เป็น pending, paid, หรือ completed”

3. ดูตัวอย่างและนำไปใช้:

• AI จะสร้าง JSON Schema เช่น:

{
  "type": "array",
  "enum": [
    [1, 2],
    [3, 4]
  ]
}

• ตรวจสอบผลลัพธ์ จากนั้นคลิก **Apply** เพื่อเพิ่มลงในฟิลด์ของคุณ

4. ทดสอบ:

• ตรวจสอบเอกสารเพื่อให้แน่ใจว่า enum ถูกต้อง ลองดีบักด้วยค่า enum ในอินเทอร์เฟซของ Apidog

AI เป็นผู้ช่วยชีวิตสำหรับสคีมาที่ซับซ้อน หรือเมื่อคุณไม่แน่ใจเกี่ยวกับไวยากรณ์ JSON มันเร็วกว่าการค้นหาใน Google และรับประกันความถูกต้อง

Mock Data และการแจงนับ

หนึ่งในคุณสมบัติที่ยอดเยี่ยมที่สุดของ **Apidog** คือการรวม enum เข้ากับ Mock data เมื่อคุณตั้งค่า enum แล้ว บริการ Mock ของ Apidog จะสร้างข้อมูลทดสอบโดยอัตโนมัติที่เคารพข้อจำกัดของคุณ ตัวอย่างเช่น:

• Enum สตริง: หาก status ถูกจำกัดให้เป็น ["active", "frozen", "deleted"], Mock data จะสุ่มเลือกหนึ่งในค่าเหล่านี้
• Enum อาร์เรย์ที่มีองค์ประกอบที่ไม่ซ้ำกัน: สำหรับอาร์เรย์ permissions ที่มี ["read", "write", "delete"] และเปิดใช้งานการไม่ซ้ำกัน คุณอาจได้ ["read", "write"] แต่ไม่เคยได้ ["read", "read"]
• Enum อาร์เรย์แบบตายตัว: ฟิลด์ coordinate ที่มี [[0, 0], [100, 100]] จะคืนค่าเพียงหนึ่งในอาร์เรย์ที่แน่นอนเหล่านั้นเท่านั้น

สิ่งนี้ทำให้แน่ใจว่าข้อมูลทดสอบของคุณสอดคล้องกับข้อกำหนด API ของคุณ ทำให้การดีบักและการทำงานร่วมกันราบรื่นขึ้น หากต้องการเปิดใช้งาน Mock data ให้สลับตัวเลือก **Mock** ใน interface editor และดูตัวอย่างผลลัพธ์

การกำหนดโมเดลการแจงนับที่นำกลับมาใช้ใหม่ได้

หาก enum เดียวกันปรากฏในหลายๆ endpoint—เช่น user_status ใน API สำหรับการสร้าง, อัปเดต และแสดงรายการผู้ใช้—การกำหนดใหม่ทุกครั้งเป็นเรื่องที่น่าเบื่อ **Apidog** ช่วยให้คุณสร้างโมเดลข้อมูลที่นำกลับมาใช้ใหม่ได้เพื่อรักษาความสอดคล้อง

1. สร้าง Data Model:

• ไปที่ **Data Models** ในโปรเจกต์ Apidog ของคุณ
• คลิก **New Model** ตั้งชื่อ (เช่น UserStatusEnum) และตั้งค่า root node เป็น string
• ใน **Advanced Settings** เพิ่มค่า enum เช่น active, frozen, deleted พร้อมคำอธิบายเพิ่มเติม

2. อ้างอิงโมเดล:

• ในอินเทอร์เฟซใดๆ ให้ตั้งค่าประเภทของฟิลด์เป็น **Reference** และเลือก UserStatusEnum

3. อัปเดตครั้งเดียว, ซิงค์ทุกที่:

• หากคุณต้องการเพิ่มสถานะใหม่ (เช่น suspended) ให้อัปเดตโมเดล UserStatusEnum แล้ว endpoint ทั้งหมดที่อ้างอิงจะอัปเดตโดยอัตโนมัติ

วิธีนี้ช่วยประหยัดเวลาและรับประกันความสอดคล้องทั่วทั้งโปรเจกต์ของคุณ เหมาะสำหรับทีมที่มีนักพัฒนาหลายคนพึ่งพา enum เดียวกัน

การแก้ไขปัญหาการแจงนับที่พบบ่อย

• Enum ไม่แสดงในเอกสาร? บันทึกอินเทอร์เฟซและรีเฟรชหน้าเอกสาร ตรวจสอบให้แน่ใจว่าฟิลด์ถูกทำเครื่องหมายเป็น **Required** หากจำเป็น
• Mock Data ไม่สนใจ Enums? ตรวจสอบว่าค่า enum ถูกตั้งค่าอย่างถูกต้องใน **Advanced Settings** หรือ JSON Schema สลับตัวเลือก **Mock** ปิดและเปิดใหม่
• ข้อผิดพลาด Enum อาร์เรย์? สำหรับ enum ระดับองค์ประกอบ ตรวจสอบให้แน่ใจว่าประเภทองค์ประกอบย่อยถูกตั้งค่าอย่างถูกต้อง สำหรับอาร์เรย์แบบตายตัว ให้ตรวจสอบไวยากรณ์ JSON Schema
• AI ไม่สร้าง Schema? ระบุคำสั่งของคุณให้ชัดเจนขึ้น (เช่น “จำกัดเฉพาะอาร์เรย์ที่แน่นอน”) และตรวจสอบให้แน่ใจว่า AI ถูกเปิดใช้งานใน **Team Settings**

เหตุใดการแจงนับจึงทำให้ Apidog โดดเด่น

การแจงนับของ Apidog เป็นตัวเปลี่ยนเกมสำหรับการออกแบบ API พวกมันช่วยชี้แจงข้อจำกัดของฟิลด์ ลดข้อผิดพลาด และเพิ่มความสามารถในการอ่านเอกสาร คุณสมบัติ AI ช่วยลดความซับซ้อนของการตั้งค่าที่ซับซ้อน ในขณะที่โมเดลที่นำกลับมาใช้ใหม่ได้ช่วยให้มั่นใจในความสอดคล้อง การรวม Mock data หมายความว่าการทดสอบของคุณจะเป็นไปตามข้อกำหนดเสมอ เมื่อเทียบกับเครื่องมืออย่าง Postman ตัวแก้ไขภาพและ AI ของ Apidog ทำให้การตั้งค่า enum ง่ายขึ้น โดยเฉพาะอย่างยิ่งสำหรับอาร์เรย์ ผู้ใช้ยกย่อง Apidog ว่า “ทำให้เอกสาร API เป็นเรื่องง่าย” และด้วยการรองรับ enum จึงเป็นเรื่องง่ายที่จะเห็นว่าทำไม

บทสรุป

การตั้งค่า การแจงนับของ Apidog เป็นเรื่องง่าย ไม่ว่าคุณจะจำกัดสตริง, ตัวเลข หรืออาร์เรย์ ตั้งแต่ visual editor ไปจนถึงการสร้าง JSON Schema ที่ขับเคลื่อนด้วย AI, Apidog ทำให้ API ของคุณแข็งแกร่งและเป็นมิตรกับนักพัฒนา ลองสร้างโมเดล enum ที่นำกลับมาใช้ใหม่ได้ หรือใช้ AI เพื่อเร่งความเร็ว และแบ่งปันเคล็ดลับของคุณในความคิดเห็น มาทำให้การออกแบบ API ราบรื่นขึ้นด้วยกัน!