Skip to content

03.01 หลักการออกแบบ API (API Design Principles) ​


📌 At a Glance ​

รายการรายละเอียด
TopicAPI Design Principles
Difficulty⭐ Beginner
Reading Time6 นาที
TargetDeveloper, System Integrator
API VersionV1.1

🎯 Learning Objectives ​

หลังจากศึกษาหัวข้อนี้แล้ว ผู้อ่านจะสามารถ

  • เข้าใจหลักการออกแบบ SISAHYGO API
  • เข้าใจมาตรฐาน REST API ที่ใช้
  • เข้าใจรูปแบบการแลกเปลี่ยนข้อมูล
  • พร้อมใช้งาน API ทุก Endpoint

Overview ​

SISAHYGO Integration Platform ออกแบบ API ตามมาตรฐาน REST API โดยใช้ HTTPS เป็นช่องทางการสื่อสาร และ JSON เป็นรูปแบบข้อมูลหลัก

API ทุก Endpoint มีรูปแบบการออกแบบที่สอดคล้องกัน ทั้ง URL, Request, Response และ Error Response เพื่อให้สามารถเรียนรู้เพียงครั้งเดียวและใช้งานได้กับทุกบริการของระบบ


Figure 3-1 API Design Principles ​

(แทรกรูป Figure 3-1 : API Design Principles)

Figure 3-1

Figure 3-1 แสดงหลักการออกแบบของ SISAHYGO API ซึ่งประกอบด้วย REST API, HTTPS, JSON, Stateless, Consistent Response และ Versioning โดยทุก Endpoint ใช้มาตรฐานเดียวกันตลอดทั้งระบบ


Key Points ​

PrincipleDescription
REST APIใช้มาตรฐาน RESTful API
HTTPSทุกการเชื่อมต่อเข้ารหัสผ่าน TLS
JSONใช้ JSON สำหรับ Request และ Response
Statelessทุก Request เป็นอิสระจากกัน
Versioningรองรับการพัฒนา API หลายเวอร์ชัน
Consistent Responseโครงสร้าง Response เป็นมาตรฐานเดียวกัน

API Design Philosophy ​

SISAHYGO API ยึดหลักการออกแบบดังต่อไปนี้

  • เรียบง่าย (Simple)
  • ใช้มาตรฐานสากล (Standard)
  • ขยายระบบได้ง่าย (Scalable)
  • ปลอดภัย (Secure)
  • รองรับการพัฒนาในอนาคต (Future Ready)

Best Practices ​

  • ใช้ HTTPS ทุกครั้ง
  • ส่งข้อมูลในรูปแบบ JSON เท่านั้น
  • ใช้ HTTP Method ให้ตรงกับวัตถุประสงค์
  • ตรวจสอบ HTTP Status Code ทุก Response
  • รองรับการเปลี่ยนแปลงเวอร์ชันของ API

Summary ​

SISAHYGO API V1.1 ถูกออกแบบตามมาตรฐาน REST API เพื่อให้เชื่อมต่อกับ Client System ได้ง่าย มีความปลอดภัย รองรับการขยายระบบ และรักษามาตรฐานเดียวกันทุก Endpoint


Next Step ​

➡️ 03.02 Base URL & Versioning

SISAHYGO API Integration Guide