JSON Schema là một bộ từ vựng cho phép bạn chú thích và xác thực các tài liệu JSON. Nó cung cấp một hợp đồng cho dữ liệu JSON của bạn, xác định cấu trúc, kiểu dữ liệu và các quy tắc xác thực.Apidog sử dụng JSON Schema để xác định cấu trúc body của yêu cầu và phản hồi, cho phép tự động xác thực và tạo tài liệu cho API của bạn.Trang này cung cấp phần giới thiệu ngắn gọn về JSON Schema. Để biết đầy đủ chi tiết về đặc tả, cú pháp và các tính năng nâng cao, hãy tham khảo Tài liệu JSON Schema chính thức. JSON Schema là gì?#
JSON Schema là một công cụ mạnh mẽ để:Xác thực dữ liệu JSON theo các quy tắc đã xác định
Ghi tài liệu cấu trúc JSON được mong đợi
Tạo dữ liệu mock dựa trên các định nghĩa schema
Đảm bảo tính nhất quán giữa các yêu cầu và phản hồi API
Các trường hợp sử dụng phổ biến#
Xác định schema body của yêu cầu cho các endpoint POST/PUT/PATCH
Chỉ định cấu trúc body phản hồi cho tất cả các phương thức HTTP
Xác thực dữ liệu đầu vào theo các định dạng được mong đợi
Tự động tạo phản hồi mock
Tạo tài liệu API toàn diện
Tìm hiểu thêm#
Để biết thông tin chi tiết về cú pháp JSON Schema, các từ khóa xác thực và các tính năng nâng cao, hãy xem Tài liệu đặc tả JSON Schema chính thức.Hãy bắt đầu với các schema đơn giản xác định các kiểu cơ bản và trường bắt buộc, sau đó dần dần thêm các quy tắc xác thực và ràng buộc khi cần.