Sử dụng Discriminator

Trong một số trường hợp nhất định, một đối tượng duy nhất có thể có nhiều dạng cấu trúc. Ví dụ, một cuốn sách có thể là eBook hoặc sách bìa mềm. Trong các trường hợp như vậy, trường discriminator có thể được sử dụng để phân biệt giữa các loại schema khác nhau.

discriminator thường được sử dụng kết hợp với oneOf hoặc anyOf để chỉ ra rằng "giá trị của một trường cụ thể xác định kiểu cụ thể của đối tượng".

Thuộc tính	Mô tả
propertyName	Chỉ định tên trường được sử dụng để phân biệt các kiểu.
mapping	Xác định ánh xạ giữa các giá trị trường và các schema tương ứng.

Cấu hình trong Apidog

Phương pháp 1: Sử dụng JSON Schema

Cấu hình oneOf qua giao diện trực quan

Mở trình chỉnh sửa yêu cầu hoặc phản hồi của API. Chọn trường bạn muốn định nghĩa là trường "Schema Composition". Nhấp vào Advanced Settings > Schema Composition > oneOf, và tham chiếu schema bạn muốn kết hợp trong oneOf, chẳng hạn như eBook và Paperback.

Thêm discriminator qua JSON Schema

Nhấp vào JSON Schema trong trình chỉnh sửa để chuyển sang chế độ mã.

Thêm cấu hình discriminator, ví dụ:

Thay thế 10331225 và 10331226 bằng ID của schema thực tế của bạn. Bạn có thể thấy các ID này khi mở bảng cấu hình JSON Schema.

Xác minh kết quả

Sau khi lưu, Apidog sẽ tự động nhận diện các kiểu khác nhau dựa trên trường type. Khi bạn Publish Docs, tài liệu API sẽ hiển thị chính xác các kiểu đã được phân biệt.

Discriminator trong tài liệu đã xuất bản

Phương pháp 2: Nhập tệp OpenAPI

Viết định nghĩa vào một tệp OpenAPI YAML hoặc JSON, ví dụ:

Ví dụ định nghĩa đầy đủ:

Sau đó, trong Apidog, chọn Import OpenAPI File.

Sau khi nhập, Apidog sẽ tự động nhận diện discriminator và ánh xạ chính xác các kiểu trong schema và định nghĩa endpoint. Khi bạn Publish Docs, tài liệu API sẽ hiển thị chính xác các kiểu đã được phân biệt.

Sử dụng Discriminator

Cấu hình trong Apidog#

Phương pháp 1: Sử dụng JSON Schema#

Phương pháp 2: Nhập tệp OpenAPI#

Cấu hình trong Apidog

Phương pháp 1: Sử dụng JSON Schema

Phương pháp 2: Nhập tệp OpenAPI