Tổng quan

Schema, một khái niệm cơ bản trong OpenAPI Specification (OAS), cũng thường được gọi là Mô hình Dữ liệu. Schema định nghĩa các kiểu dữ liệu và thuộc tính dự kiến của các đối tượng yêu cầu và phản hồi API.

JSON Schema đóng vai trò là tiêu chuẩn được Apidog áp dụng để mô hình hóa các cấu trúc dữ liệu được API của bạn sử dụng.

Với schema, bạn có thể:

Định nghĩa các cấu trúc dữ liệu tiêu chuẩn (chẳng hạn như đối tượng Order).

Tích hợp schema với các ví dụ được tạo tự động.

Tái sử dụng các cấu trúc dữ liệu trong toàn bộ dự án API của bạn.

Mục đích của Schema trong Apidog

Trong Apidog, schema đóng vai trò then chốt trong:

Mục đích	Mô tả
Thiết kế API	Bằng cách định nghĩa schema sớm trong giai đoạn thiết kế, nhà phát triển có thể trực quan hóa và tinh chỉnh các cấu trúc dữ liệu mà API của họ sẽ xử lý.
Mock dịch vụ	Apidog sử dụng các schema đã định nghĩa để tạo phản hồi mock, cho phép nhà phát triển mô phỏng hành vi API và tương tác front-end ngay cả trước khi triển khai thực tế.
Tài liệu	Tài liệu API chính xác và toàn diện được tự động tạo dựa trên các schema, giúp giao tiếp rõ ràng với người dùng API về các định dạng và cấu trúc dữ liệu dự kiến.
Gỡ lỗi	Schema được sử dụng để xác thực các phản hồi trong quá trình gỡ lỗi API, đảm bảo rằng các phản hồi API tuân thủ các mô hình dữ liệu đã định nghĩa.

Tạo Schema

Hãy cân nhắc phạm vi của schema: Dữ liệu sẽ được sử dụng trên nhiều phần API hoặc nhiều API, hay chỉ dành riêng cho một trường hợp sử dụng duy nhất?

Nếu cấu trúc dữ liệu được dự định sử dụng nhiều lần, việc tạo schema sẽ giúp quản lý tập trung và đảm bảo tính nhất quán.

Bạn có thể thêm schema trong thư mục "Schemas".

Xây dựng Schema

Tận dụng Schema Editor thân thiện với người dùng trong Apidog để xây dựng schema một cách hiệu quả, phù hợp với các đặc tả JSON Schema.

Bạn cũng có thể xây dựng schema bằng cách nhập từ bảng cơ sở dữ liệu hoặc dữ liệu JSON/JSON schema.

Áp dụng Schema

Sau khi thiết lập một schema có thể tái sử dụng, hãy điều hướng đến các endpoint để tham chiếu schema trong body của yêu cầu hoặc phản hồi, hoặc trong các schema khác. Bằng cách tham chiếu một mô hình dữ liệu dùng chung, bạn có thể duy trì tính nhất quán và hợp lý hóa việc tích hợp mô hình dữ liệu trên nhiều thành phần khác nhau trong thiết kế API của mình.

Mục đích của Schema trong Apidog#

Tạo Schema#

Xây dựng Schema#

Áp dụng Schema#

Mục đích của Schema trong Apidog

Tạo Schema

Xây dựng Schema

Áp dụng Schema