แนวทางทั่วไปคือการละเว้นการกำหนดเวอร์ชันเมื่อเป็นไปได้ เช่น เมื่อ API ให้บริการไคลเอ็นต์ภายใน … การตัดสินใจเลือกเวอร์ชันหรือไม่ขึ้นอยู่กับทางเลือกของนักพัฒนาและความจำเป็น แต่ Vester แนะนำไม่ให้กำหนดเวอร์ชัน API ของคุณ เว้นแต่จำเป็นจริงๆ.
คุณควรกำหนดเวอร์ชัน API ของคุณเมื่อใด
เมื่อจำนวนผู้ใช้ API มีจำนวนน้อย (หรือศูนย์) หรือเมื่อผู้บริโภคอยู่ภายในและคุณสามารถประสานการเปลี่ยนแปลง API ได้อย่างง่ายดาย ผลกระทบก็สามารถเกิดขึ้นได้ ย่อเล็กสุด อย่างไรก็ตาม การเปลี่ยนแปลงใดๆ ที่ผู้บริโภค API ต้องการนั้นทำให้เสียเวลาและความพยายาม ด้วยเหตุนี้ การสร้าง API เวอร์ชันใหม่จึงควรเป็นทางเลือกสุดท้าย
ทำไมคุณควรกำหนดเวอร์ชัน API ของคุณ
เมื่อ จำนวนผู้ใช้ API น้อย (หรือศูนย์) หรือเมื่อผู้บริโภคอยู่ภายในและคุณสามารถประสานงานการเปลี่ยนแปลง API ได้อย่างง่ายดาย ผลกระทบอาจ ย่อเล็กสุดอย่างไรก็ตาม การเปลี่ยนแปลงใดๆ ที่ผู้บริโภค API ต้องการนั้นทำให้เสียเวลาและความพยายาม ด้วยเหตุนี้ การสร้าง API เวอร์ชันใหม่จึงควรเป็นทางเลือกสุดท้าย
การกำหนดเวอร์ชัน API ไม่ดีหรือไม่
ทำไม API การกำหนดเวอร์ชันไม่ดี การสร้าง API ใช้เวลานานและมีค่าใช้จ่ายสูง การกำหนดเวอร์ชันก็เช่นกัน … คุณจะต้องจัดการกับความสับสนและความไม่พอใจของนักพัฒนา เนื่องจากการอัปเดตโค้ดหรือการเปลี่ยน API นั้นฟังดูไม่สนุกเลย
การกำหนดเวอร์ชัน API เป็นแนวปฏิบัติที่ดีหรือไม่
ต้องมีการกำหนดเวอร์ชัน API เนื่องจากทำให้มั่นใจได้ถึงความเสถียรและความน่าเชื่อถือ หากคุณไม่กำหนดเวอร์ชัน API อย่างถูกต้อง อาจส่งผลกระทบร้ายแรงต่อผลิตภัณฑ์และบริการดาวน์สตรีม เช่นเดียวกับเทคโนโลยีอื่นๆ API นั้นเชื่อมต่อถึงกันและอาศัยระบบ ซอฟต์แวร์ และฐานข้อมูลที่หลากหลายในการทำงาน