Docker Engine API v1.57.0 chuyển sang OpenAPI 3.2: việc cần làm

Docker

Docker Engine API v1.57.0 chuyển đặc tả chính sang OpenAPI 3.2, bổ sung thuộc tính restarting cho sự kiện container die và sửa schema ImageManifestSummary.ImageData. Công cụ phụ thuộc Swagger 2.0 theo từng phiên bản cần lên kế hoạch chuyển đổi trước các phiên bản API tương lai.

Tóm tắt nhanh
Docker Engine API v1.57.0 chuyển đặc tả chính sang OpenAPI 3.2.
Công cụ phụ thuộc Swagger 2.0 theo từng phiên bản cần lưu ý thay đổi với các API tương lai.
Sự kiện container die có thể bổ sung thuộc tính restarting để báo hiệu ý định khởi động lại.
Ưu tiên rà soát công cụ nội bộ và lập kế hoạch chuyển sang OpenAPI 3.2.

Nội dung bài viết

Docker Engine API là giao diện để công cụ và ứng dụng tương tác với Docker Engine. Bản phát hành Docker Engine API v1.57.0 cập nhật đặc tả, thay đổi cách biểu diễn sự kiện container và sửa schema liên quan đến dữ liệu image.

Tổng quan và thông tin kỹ thuật

Thông tin	Chi tiết
Sản phẩm	Docker Engine API
Bản phát hành	API v1.57.0
Đặc tả chính	OpenAPI 3.2 tại `api/openapi.yaml`
Swagger 2.0	Bản tổng quát tại `api/swagger.yaml`; bản cố định cho API v1.57 tại `api/docs/v1.57-swagger.yaml`

Phạm vi ảnh hưởng

Thay đổi cần lưu ý đối với các công cụ phụ thuộc vào tệp Swagger 2.0 theo từng phiên bản. Bản phát hành này vẫn cung cấp Swagger 2.0 tổng quát và bản cố định cho API v1.57, nhưng các phiên bản API tương lai sẽ không có bản Swagger 2.0 riêng theo từng phiên bản. Vì vậy, các công cụ phụ thuộc vào những tệp đó cần được chuyển sang OpenAPI 3.2 trước khi nâng cấp lên các phiên bản API tương lai.

Cơ chế và tác động

Với sự kiện GET /events loại container die, thuộc tính restarting="true" xuất hiện khi container sắp khởi động lại theo restart policy hoặc do thao tác khởi động lại thủ công. Thuộc tính bị lược bỏ nếu container không khởi động lại, kể cả khi daemon tắt; nó báo hiệu ý định khởi động lại nhưng không đảm bảo việc này sẽ thành công hoặc không bị hủy.

Bản phát hành cũng sửa schema ImageManifestSummary.ImageData: UnpackedSize không tồn tại; kích thước giải nén được báo cáo trong Size.Unpacked.

Kiểm tra hệ thống

Kiểm tra API version mà Docker Engine Client và Server hỗ trợ; đối chiếu mục API version với API v1.57.
```
docker version
```
Lệnh này không xác nhận API nào có trong một bản phát hành cụ thể.

Khắc phục và giảm thiểu

Rà soát công cụ nội bộ phụ thuộc vào các bản Swagger 2.0 theo từng phiên bản và lập kế hoạch chuyển sang đặc tả OpenAPI 3.2 tại api/openapi.yaml trước khi nâng cấp lên các phiên bản API tương lai.
Nếu cần Swagger 2.0, bản tổng quát vẫn có tại api/swagger.yaml; bản tương thích cố định với API v1.57 có tại api/docs/v1.57-swagger.yaml.

Nguồn tham khảo: Docker Release