Phiên bản API là gì
Quản lý phiên bản API
Phiên bản API
Quản lý phiên bản API là thực hành quản lý các thay đổi API trong khi duy trì khả năng tương thích ngược cho các client hiện có.
Chiến lược phiên bản
| Chiến lược | Ví dụ | Mô tả | |------------|-------|-------| | Đường dẫn URL | /api/v1/users | Phiên bản trong đường dẫn URL | | Tham số Query | /api/users?version=1 | Phiên bản trong tham số | | Header | X-API-Version: 1 | Phiên bản trong header | | Content Type | Accept: application/vnd.api.v1+json | Phiên bản media type |
Semantic Versioning
- Major (v1→v2) — thay đổi phá vỡ
- Minor (v1.1→v1.2) — tính năng mới, tương thích ngược
- Patch (v1.1.0→v1.1.1) — sửa lỗi
Thực hành tốt nhất
- Ghi lại tất cả thay đổi (changelog)
- Hỗ trợ ít nhất 2 phiên bản
- Thông báo deprecation trước
- Sử dụng sunset headers
- Cung cấp công cụ di chuyển
Khi nào cần phiên bản mới
- Xóa trường hoặc endpoints
- Thay đổi định dạng phản hồi
- Thay đổi ngữ nghĩa tham số
- Thay đổi xác thực