Trình tạo Lược đồ JSON

Trình Trình tạo Lược đồ JSON chuyển đổi dữ liệu JSON mẫu thành một lược đồ sẵn sàng xác thực cho các API, webhook, tệp cấu hình, đường ống dữ liệu (data pipelines) và tài liệu hướng dẫn. Hãy dán một đối tượng JSON, mảng hoặc nguồn cấp dữ liệu NDJSON đại diện, chọn kiểu suy luận và công cụ sẽ xây dựng một lược đồ với các thuộc tính lồng nhau, quy tắc cho mục mảng, giá trị có thể null, ví dụ và ghi chú chi tiết theo từng đường dẫn dễ đọc.

Tại sao nên sử dụng Trình Trình tạo Lược đồ JSON dựa trên dữ liệu mẫu?

Viết JSON Schema bằng tay mang lại độ chính xác cao nhưng rất chậm, đặc biệt khi dữ liệu chứa các đối tượng lồng nhau, mảng bản ghi, các trường tùy chọn và giá trị có thể null. Trình tạo này cung cấp cho bạn một bản phác thảo đầu tiên có cấu trúc chặt chẽ, ghi lại hình dáng quan sát được từ dữ liệu JSON của bạn, sau đó làm nổi bật những nơi vẫn cần con người xem xét lại. Nó rất hữu ích cho việc xác thực yêu cầu API, hợp đồng phản hồi, làm việc với OpenAPI, payload của webhook, luồng sự kiện và lược đồ cấu hình.

Cách sử dụng

1. Dán một đối tượng JSON, mảng JSON hoặc các bản ghi JSON phân tách bằng dòng mới mang tính đại diện vào trình chỉnh sửa mẫu.
2. Chọn phiên bản JSON Schema draft và quyết định xem có suy luận các trường bắt buộc, ví dụ, gợi ý enum, định dạng chuỗi và các đối tượng đóng hay không.
3. Nhấp vào Tạo JSON Schema để suy luận các kiểu dữ liệu, thuộc tính lồng nhau, các mục mảng, trường có thể null và các gợi ý xác thực.
4. Kiểm tra sơ đồ được tạo để xem từng đường dẫn, kiểu suy luận, trạng thái bắt buộc, định dạng và quy tắc trước khi sử dụng lược đồ.
5. Sao chép lược đồ được tạo và tinh chỉnh các quy tắc xác thực đặc thù của miền như phạm vi chính xác, mẫu ID và các enum đặc thù của doanh nghiệp.

Những gì Trình tạo có thể suy luận

• Các kiểu JSON cốt lõi: object, array, string, number, integer, boolean, và null.
• Các thuộc tính đối tượng lồng nhau và các trường bắt buộc dựa trên những gì xuất hiện trong mọi đối tượng được quan sát.
• Lược đồ mục mảng bằng cách hợp nhất các mục quan sát được trong mẫu.
• Các định dạng chuỗi phổ biến bao gồm email, URL, date, date-time, UUID, IPv4 và IPv6.
• Các ví dụ tùy chọn, gợi ý enum, phạm vi số quan sát được và độ dài chuỗi quan sát được.

Câu hỏi thường gặp (FAQ)

Trình Trình tạo Lược đồ JSON này làm được gì?

Nó đọc dữ liệu JSON mẫu và tạo ra một JSON Schema mô tả hình dáng dữ liệu quan sát được. Trình tạo sẽ suy luận các thuộc tính đối tượng, mảng, kiểu nguyên thủy, giá trị có thể null, ví dụ, gợi ý enum, trường bắt buộc và các định dạng chuỗi phổ biến.

Lược đồ được tạo có thể được sử dụng ngay trong môi trường production không?

Hãy sử dụng nó như một điểm khởi đầu vững chắc, sau đó xem lại. Dữ liệu mẫu không thể biết mọi quy tắc kinh doanh, vì vậy bạn vẫn có thể cần thêm các mẫu (patterns), phạm vi chính xác, các giá trị enum được phép, quy tắc phiên bản và cài đặt additionalProperties nghiêm ngặt hơn.

Những phiên bản JSON Schema draft nào được hỗ trợ?

Công cụ có thể tạo lược đồ cho Draft 2020-12, Draft 2019-09 và Draft-07 bằng cách thiết lập URI $schema. Cấu trúc suy luận được thiết kế có chủ ý để tương thích với các trình xác thực phổ biến.

Các trường bắt buộc được suy luận như thế nào?

Khi tính năng suy luận bắt buộc được bật, một thuộc tính chỉ được đánh dấu là bắt buộc khi nó xuất hiện trong mọi đối tượng được quan sát ở cấp độ đó. Đối với một mảng các đối tượng, điều này có nghĩa là trường đó phải xuất hiện trong mọi mục mẫu.

Công cụ có hỗ trợ mảng các đối tượng và NDJSON không?

Có. Một mảng JSON cấp cao nhất được xử lý như một lược đồ mảng, và các bản ghi JSON phân tách bằng dòng mới được xử lý như một mảng các bản ghi. Các thuộc tính của mục được hợp nhất từ các mẫu quan sát được.