ออกแบบ API Services

เมื่อเตรียมชุดข้อมูล ที่ต้องการใช้ในระบบ สำหรับแต่ละเส้น API Services เรียบร้อยแล้ว ในส่วนของการสร้างหรือออกแบบบริการ ซึ่งมีการสร้างบริการเพื่อกำหนดกลุ่มของชุดข้อมูล โดยแต่ละชุดข้อมูลจะถูกนำมาสร้างเป็น API Sevices ซึ่งจะมีการออกแบบ Path และการกำหนดข้อมูลที่นำมาใช้ในการออกเป็นบริการ

การสร้างบริการ (Services)

การสร้างบริการ (Services) เป็นการระบุให้ทราบว่ามี API Services ในรูปแบบไหนให้บริการอยู่ ซึ่งในบริการที่สร้างขึ้นจะประกอบไปด้วย API Services หลากหลายเส้น (Path) ที่สามารถนำข้อมูลไปใช้แสดงผลบนเว็บไซต์ได้

ขั้นตอนการสร้างบริการ

1. คลิกที่ปุ่มสร้างบริการ (Create Services) ที่มุมบนขวาของเมนูบริการ (Service)
2. ระบุข้อมูลสำหรับสร้างบริการ ซึ่งมี ดังต่อไปนี้
   • ชื่อ (Name) : ชื่อบริการ เช่น Hotspot API
   • นามแฝง (Alias) : นามแฝงสำหรับบริการ ซึ่งไม่สามารถตั้งชื่อที่ซ้ำกันได้
   • คำอธิบาย (Description) : คำอธิบายรายละเอียด เพื่อสร้างความเข้าใจเกี่ยวกับ API Services ที่ให้บริการ
   • แท็ก (Tag) : การกำหนดกลุ่มของ API Service ในแต่ละเส้น (Path) เพื่อให้ง่ายต่อความเข้าใจเมื่อนำไปใช้งาน
3. คลิกปุ่มสร้าง (Create)

tip

Alias ที่สร้างขึ้นสามารถใช้งานแทน ID ได้

ขั้นตอนการแก้ไขบริการ (Service)

การแก้ไข Services เป็นการแก้ไขข้อมูลรายละเอียด เช่น ชื่อ และคำอธิบาย รวมถึงการจัดการ Tag เพื่อใช้จัดหมวดหมู่ของ API Sevices

• คลิกบริการ (Service) ที่ต้องการแก้ไข
• เลือกเมนูแก้ไข (Edit)
• เมื่อทำการแก้ไขเสร็จเรียบร้อยให้ คลิกปุ่มแก้ไข (Edit) เพื่อบันทึกการเปลี่ยนแปลง

ขั้นตอนการลบบริการ (Service)

• ไปที่หน้าการจัดการบริการ
• คลิกที่จุด 3 จุดของบริการที่ต้องการลบแล้ว คลิกที่ปุ่มลบ(Delete)

ขั้นตอนการแสดงผลบริการในรูปแบบ Swagger

• คลิกที่จุด 3 จุดของบริการ
• เลือกเมนูแสดงตัวอย่าง (Preview) ซึ่งจะแสดงรายการ API Service ตามเส้นบริการ (Services path) ที่ทำการสร้างขึ้น

tip

Swagger คือ คู่มือการใช้ API Service หรือ Open specifivation API

การจัดการเส้น (Path managment)

เมื่อทำการสร้างบริการ (Services) ในแต่ละบริการย่อมมี API Services ให้บริการ ผู้ใช้งานจำเป็นต้องทำการจัดการเส้นบริการ (Services path)โดยมีการระบุ ข้อมูลที่นำมาใช้สร้างบริการ ซึ่งได้ข้อมูลมาจากจัดทำชุดข้อมูล

ขั้นตอนการจัดการเส้นบริการ (Services path)

1. คลิกที่ปุ่มจุด 3 จุดของบริการที่สร้างขึ้น
2. เลือกเมนูการจัดการเส้น (Path management)
3. คลิกที่ปุ่มสร้างเส้น (Create path) ที่มุมบนขวา
4. ระบุข้อมูลและรายละเอียดในการสร้างเส้น (Path)
   • Type : ประเภทข้อมูลที่นำมาสร้างบริการ (Services)
     • ชุดข้อมูล (Dataset) คือ ชุดข้อมูลที่ผู้ใช้งานทำการสร้างขึ้นในระบบ
     • ข้อมูลภายนอก (Third Party) คือ ชุดข้อมูลภายนอกที่สามารถนำเข้าได้ในรูปแบบลิงก์ URL (JSON)
   • Method : เมธอดในการเรียกใช้งาน Services
   • Path : รูปแบบเส้น (Path) สำหรับการเรียกใช้งานบริการ
   • Name : ชื่อเรียกเส้นบริการ (Services path)
   • Description : คำอธิบายเส้นบริการ (Services path) เพื่อบอกรายละเอียดทั่วไปเกี่ยวกับข้อมูลใน API Services
   • Tag : การกำหนดแท็กในการจัดหมวดหมู่ของ API Services
   • Parameter : พารามิเตอร์สำหรับส่งข้อมูลเพื่อใช้ในกรองข้อมูลสำหรับเรียกใช้ API Service เช่น Id หรือ ตัวแปรในการกรองข้อมูลอื่นๆ โดยจะมีการสร้าง Parameter Default มาให้ 3 ตัว คือ Offset, Limit, Sort
5. เมื่อทำการระบุข้อมูลและรายละเอียดเรียบร้อยแล้ว คลิกปุ่มสร้าง (Create) เพื่อสร้างเส้นบริการ (Services path)

ขั้นตอนการแก้ไขเส้นบริการ (Services path)

1. ไปที่หน้าการจัดการเส้นบริการ
2. เลือกบริการที่ต้องการแก้ไข คลิกที่ปุ่มจุด 3 จุดเลือกเมนูแก้ไข (Edit)
3. เมื่อทำการแก้ไขข้อมูลเรียก คลิกปุ่มแก้ไข (Edit) เพื่อบันทึกกการเปลี่ยนแปลง

ขั้นตอนการลบเส้นบริการ (Services path)

• ไปที่หน้าการจัดการเส้นบริการ
• คลิกที่จุด 3 จุดของเส้นบริการที่ต้องการลบ คลิกที่ปุ่มลบ (Delete)

ทดสอบการทำงานของ API

การทำสอบการทำงานของ API Services ผู้ใช้งานสามารถทดสอบผ่าน Swagger โดยใช้ API Key ที่สร้างขึ้นบนระบบเป็นตัวเข้าถึงบริการ ซึ่งมีขั้นตอนทดสอบ ดังต่อไปนี้

1. เมื่อทำการแสดงตัวอย่าง (Preview) ของบริการที่สร้างขึ้น
2. ทำการ Authorize โดยใช้ API Key ของระบบ
3. คลิกที่ Path ที่ต้องการทดสอบ API Service
4. หากมี Parameter ที่ Require ให้ทำการใส่ Parameter ให้ครบถ้วน
5. คลิกที่ปุ่ม Try เพื่อทดสอบการเรียก API

tip

หากทำการเรียก API สำเร็จจะแสดง Status Code เป็น 200 และข้อมูลที่เรียกออกมา