Khi API phát triển để đáp ứng nhu cầu thị trường và tận dụng các tiến bộ công nghệ, việc quản lý phiên bản trở nên thiết yếu. Open APIs đóng vai trò là các kênh quan trọng để đội ngũ kỹ thuật cung cấp dịch vụ và dữ liệu ra bên ngoài. Tuy nhiên, sự phát triển của doanh nghiệp và tiến bộ công nghệ tất yếu dẫn đến nhiều lần lặp phiên bản cho các endpoint của bạn. Sự thay đổi này là tự nhiên và cần thiết khi các đội ngũ tối ưu hóa chức năng, giới thiệu tính năng mới và xử lý lỗi.Quản lý nhiều phiên bản API là yếu tố quan trọng để phục vụ các nhóm người dùng khác nhau, đồng thời bảo đảm cả khả năng tương thích và đổi mới. Cách tiếp cận này cho phép các đội ngũ cung cấp dịch vụ ổn định, liên tục phát triển trong khi vẫn duy trì kiểm soát phiên bản, giảm thiểu gián đoạn cho người dùng hiện tại và bảo đảm tính liên tục cũng như độ tin cậy của hoạt động kinh doanh.
Các đội ngũ có thể cần cung cấp đồng thời nhiều phiên bản API—chẳng hạn như phiên bản mới nhất, phiên bản ổn định và phiên bản bảo trì dài hạn—để bảo đảm mức độ gián đoạn tối thiểu cho người dùng trên các phiên bản cũ hơn.
Tạo phiên bản đầy đủCó thể tạo một phiên bản API mới dựa trên một phiên bản API hiện có, chứa các bản sao của tất cả endpoint từ phiên bản gốc. Sau khi tạo, từng endpoint trong phiên bản có thể được sửa đổi khi cần. Ngoài ra, bạn cũng có thể bắt đầu từ một phiên bản API trống và thêm endpoint theo cách thủ công.
Chia sẻ toàn diệnChọn một hoặc nhiều phiên bản API từ dự án của bạn để xuất bản. Tất cả endpoint trong các phiên bản đã chọn sẽ hiển thị với người dùng. Khi xuất bản, có thể cấu hình tên hiển thị và thiết lập slug của phiên bản API để nâng cao trải nghiệm của người đọc.
Chuyển đổi bằng một cú nhấp chuộtNếu nhiều phiên bản API đã được xuất bản, người dùng có thể chuyển đổi giữa chúng thông qua bộ chọn phiên bản nằm bên cạnh tên dự án trên trang công khai. Khi nhấp vào một phiên bản, tất cả endpoint và nội dung liên quan cho phiên bản cụ thể đó sẽ được hiển thị.
Khác biệt giữa "Phiên bản API" và "Sprint Branch"
Phiên bản API: Được thiết kế để phát hành ra bên ngoài, đặc biệt khi các thay đổi lớn gây ra những điểm không tương thích đáng kể giữa các phiên bản. Chứa tất cả endpoint, không chỉ các endpoint đã sửa đổi hoặc mới được thêm vào
Sprint Branch: Được các đội ngũ phát triển sử dụng nội bộ, phù hợp với khái niệm "sprint" trong phát triển linh hoạt. Mỗi sprint thường tạo một nhánh chỉ bao gồm các endpoint mới hoặc đã sửa đổi, không bao gồm các endpoint không thay đổi
