การบริการ API

Service เมนู Service เป็นส่วนของการจะนำผลลัพธ์จากการทำ Dataset ให้ออกเป็น API เพื่อนำไปใช้ในการพัฒนาต่อไป

วิธีการสร้าง Service

• คลิกที่ปุ่ม Create Service ที่อยู่ในเมนู Service
• ในการสร้าง Service แบ่งออกเป็น 3 ส่วนคือ
  • Service Information
  • Tag List
  • Create Path
• ทำการกรอกข้อมูลรายละเอียดเกี่ยวกับ Service
• สร้าง Path ที่ปุ่ม Create Path สำหรับการนำ API Service ไปใช้

tip

Tag คือ Tag List จะแสดงเมื่อทำการเพิ่ม Tag แล้ว

Service Information การกรอกข้อมูลและรายละเอียดของ Service

• Service Name กำหนดชื่อ Service ให้เหมาะสมและสื่อความหมาย
• Alias Name กำหนดชื่อ Alias ของ Service
• Description กำหนดอธิบายของ Service เพื่อให้ทราบว่า Service นี้สามารทำอะไรได้บ้างและบอกข้อมูลอะไรบ้าง ซึ่งจะเขียนหรือไม่เขียนก็ได้

Create Path การกำหนดรูปแบบ Path ของ API Service ให้มีสื่อความหมายและเหมาะสมโดยมีการระบุข้อมูลดังต่อไปนี้

• Type กำหนดประเภท Dataset ของ Service
• Datasetกำหนด Dataset ที่ต้องการนำออกไปเป็น Service
• Path กำหนดรูปแบบ Path ของ Service ที่ต้องการนำไปใช้
• Name กำหนดชื่อของ Path
• Description กำหนดคำอธิบายของ Path
• Tag การจัดกลุ่ม Path ของ API Service
• Parameter เป็น Parameter ที่ต้องการใช้ในการ Query เพื่อให้ได้รับข้อมูลมาตามที่ต้องการ โดยจะมีการสร้าง Parameter Default มาให้ 3 ตัว คือ Offset, Limit, Sort

วิธีการแก้ไข Service มี 2 วิธีดังต่อไปนี้

• คลิกที่ Service ที่ต้องการแก้ไขได้เลย
• คลิกที่จุด 3 จุดของ Service ที่ต้องการแก้ไขแล้วคลิกที่ปุ่ม Edit

วิธีการลบ Service

• คลิกที่จุด 3 จุดของ Service ที่ต้องการลบแล้วคลิกที่ปุ่ม Delete

วิธีการส่งออก Service ออกเป็น Swagger

• คลิกที่จุด 3 จุดของ Service ที่ต้องการสร้าง Swagger แล้วคลิกที่ปุ่ม Swagger

tip

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

วิธีการทดสอบ API ด้วย Swagger

• คลิกที่ Path ที่ต้องการทดสอบ API Service
• ทำการ Authorize โดยใช้ API Key ของ...
• คลิกที่ปุ่ม Try it out เพื่อทดสอบการเรียก API
• หากมี Parameter ที่ Require ให้ทำการใส่ Parameter ก่อน
• คลิกที่ปุ่ม Execute

tip

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