คืออะไร การกำหนดเวอร์ชัน API
การจัดการเวอร์ชัน API
การกำหนดเวอร์ชัน API
การกำหนดเวอร์ชัน API คือแนวทางในการจัดการการเปลี่ยนแปลง API ในขณะที่รักษาความเข้ากันได้ย้อนหลังสำหรับไคลเอนต์ที่มีอยู่
กลยุทธ์การกำหนดเวอร์ชัน
| กลยุทธ์ | ตัวอย่าง | คำอธิบาย | |---------|---------|----------| | เส้นทาง URL | /api/v1/users | เวอร์ชันในเส้นทาง URL | | พารามิเตอร์ Query | /api/users?version=1 | เวอร์ชันในพารามิเตอร์ | | Header | X-API-Version: 1 | เวอร์ชันใน header | | Content Type | Accept: application/vnd.api.v1+json | เวอร์ชัน media type |
การกำหนดเวอร์ชันแบบ Semantic
- Major (v1→v2) — การเปลี่ยนแปลงที่ทำลาย
- Minor (v1.1→v1.2) — ฟีเจอร์ใหม่ เข้ากันได้ย้อนหลัง
- Patch (v1.1.0→v1.1.1) — แก้ไขข้อผิดพลาด
แนวทางปฏิบัติที่ดีที่สุด
- บันทึกการเปลี่ยนแปลงทั้งหมด (changelog)
- รองรับอย่างน้อย 2 เวอร์ชัน
- ประกาศ deprecation ล่วงหน้า
- ใช้ sunset headers
- จัดเตรียมเครื่องมือการย้าย
เมื่อใดต้องการเวอร์ชันใหม่
- การลบฟิลด์หรือ endpoints
- การเปลี่ยนรูปแบบการตอบสนอง
- การเปลี่ยนความหมายของพารามิเตอร์
- การเปลี่ยนการยืนยันตัวตน