API Versioning: เปลี่ยน API โดยไม่ทำระบบที่เชื่อมต่อพัง

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

Breaking กับ Non-breaking Change

การเพิ่มฟิลด์ใหม่ที่ไม่บังคับ มักไม่ทำให้ของเดิมพัง เรียกว่า non-breaking แต่การลบฟิลด์ เปลี่ยนชนิดข้อมูล หรือเปลี่ยนความหมาย คือ breaking change ที่ทำให้คนที่ใช้อยู่พัง หลักการคือ เพิ่มได้ แต่อย่าลบหรือเปลี่ยนของเดิมเงียบ ๆ ถ้าจำเป็นต้องเปลี่ยนใหญ่ ให้ออกเวอร์ชันใหม่ และให้เวอร์ชันเก่ายังทำงานต่อไปอีกระยะ

• ระบุเวอร์ชันให้ชัด เช่น ใน URL หรือ header เพื่อให้ผู้ใช้เลือกได้
• ประกาศล่วงหน้าเมื่อจะเลิกรองรับเวอร์ชันเก่า และให้เวลาย้าย
• ทำเอกสารและตัวอย่างให้ชัด เพราะ API คือผลิตภัณฑ์สำหรับนักพัฒนา

สำหรับธุรกิจที่มีพาร์ตเนอร์เชื่อมต่อหรือมีแอปหลายตัวใช้ระบบหลังบ้านร่วมกัน API Versioning คือเรื่องของความน่าเชื่อถือ การเปลี่ยน API อย่างมีระเบียบ ทำให้พาร์ตเนอร์ไว้ใจที่จะลงทุนเชื่อมต่อกับคุณ เพราะรู้ว่าจะไม่ตื่นมาเจอระบบพังเพราะคุณแก้อะไรเงียบ ๆ