Cách dùng JSON sang JSON Schema
- Dán một ví dụ JSON, chẳng hạn phản hồi API, file cấu hình hoặc bản ghi cơ sở dữ liệu, hoặc nhấn Mẫu.
- Để kết quả chính xác hơn, hãy dán nhiều ví dụ dưới dạng mảng JSON: trường thiếu ở một số ví dụ sẽ thành không bắt buộc, còn kiểu dữ liệu khác nhau sẽ thành union.
- Chọn draft, cách xác định required, và có nhận diện định dạng, tạo enum, cấm thuộc tính thừa hay giữ lại ví dụ hay không.
- Sao chép hoặc tải schema về, hoặc gửi trực tiếp sang công cụ chuyển JSON Schema sang TypeScript hoặc bộ kiểm tra.
Cách schema được suy luận
- Kiểu dữ liệu: chuỗi, số, số nguyên, boolean, null, đối tượng và mảng. Trường đôi khi là số, đôi khi là null sẽ thành
"type": ["number", "null"]. - Mảng: mọi phần tử được gộp vào một schema
itemsduy nhất, nên một mảng đối tượng người dùng sẽ có một schema người dùng với tất cả khóa đã thấy. - Bắt buộc: mặc định, một khóa chỉ là bắt buộc nếu nó xuất hiện trong mọi đối tượng có cấu trúc đó. Với một ví dụ duy nhất, tất cả khóa đều bắt buộc.
- Định dạng: chuỗi nào cũng trông giống email, URI, UUID, ngày, date-time, giờ, IPv4 hoặc IPv6 sẽ có
format. - Enum: trường chuỗi có vài giá trị lặp lại qua nhiều ví dụ (như
status) sẽ thànhenum.
Schema được suy luận mô tả các ví dụ của bạn, không phải ý định thực sự của bạn, nên hãy xem lại: siết chuỗi bằng minLength hoặc pattern, thêm minimum/maximum cho số và quyết định trường nào thực sự là tùy chọn. Sau đó, kiểm tra dữ liệu với JSON Schema Validator hoặc tạo kiểu TypeScript với JSON Schema to TypeScript.
Cũng được tìm dưới tên: tạo json schema từ json, json schema generator, sinh json schema online, infer json schema, json schema từ ví dụ, json schema draft 2020-12, chuyển json sang schema.
Các công cụ dùng kèm tốt với JSON sang JSON Schema
- JSON sang TypeScript — Dán một mẫu JSON như phản hồi API hay file cấu hình, bạn sẽ nhận ngay các TypeScript interface sẵn sàng dùng, với kiểu lồng nhau, thuộc tính optional và union type.
- Định dạng JSON — Dán JSON để định dạng đẹp, nén hoặc kiểm tra.
- Kiểm tra OpenAPI / Swagger — Dán đặc tả API vào để kiểm tra theo schema OpenAPI chính thức, phát hiện tham chiếu hỏng và tham số path không nhất quán, đồng thời xem toàn bộ endpoint chỉ trong một cái nhìn.
- Tạo dữ liệu giả — Tạo tới 10.000 dòng dữ liệu test chân thực — người dùng, sản phẩm, đơn hàng, địa chỉ, công ty hoặc bản ghi API lồng nhau — hoặc tự xây dựng schema riêng.