JSON Swiss

JSON Swiss

Trình tạo JSON Schema từ Ruby Class

Đầu vào: Ruby code

Đang tải trình soạn thảo…

Đầu ra: JSON Schema

Cài đặt

Chọn class nào sẽ được xem là root của JSON Schema.

Việc parse chạy hoàn toàn trong trình duyệt. Source của bạn không rời khỏi trang.

Dán Ruby classes để tạo JSON Schema ngay lập tức.

Hỗ trợ attr_accessor/attr_reader, nested classes và bỏ qua methods.

Cách chuyển Ruby classes sang JSON Schema – hướng dẫn từng bước

Công cụ Ruby class → JSON Schema trực tuyến này giúp bạn tạo JSON Schema từ các model thực (DTOs, structs và classes) để bạn có thể validate payloads, chia sẻ contracts và tạo mock JSON.

  1. Bước 1 – Dán source Ruby

    • Dán các model bạn muốn tài liệu hóa vào trình soạn thảo bên trái.
    • Bao gồm các type được tham chiếu trong cùng một snippet để schema có thể tạo definitions.
    • Dùng nút Mẫu để tải ví dụ và xem định dạng đầu vào mong đợi.

  2. Bước 2 – Chọn Root class (nếu cần)

    • Nếu phát hiện nhiều định nghĩa, hãy chọn root khớp với API payload của bạn.
    • Schema đầu ra được xây quanh root đã chọn và có thể bao gồm thêm definitions cho các type được tham chiếu.

  3. Bước 3 – Kiểm tra JSON Schema đầu ra

    • Kiểm tra types, trường bắt buộc vs tùy chọn và cấu trúc object/array lồng nhau.
    • Hãy chú ý definitions và $ref khi model của bạn tham chiếu đến model khác.
    • Sao chép hoặc tải schema xuống để dùng cho validation, tài liệu hoặc schema-first development.

  4. Bước 4 – Validate hoặc tạo mock JSON

    • Nhấp Tạo mock data để mở mock generator với schema đã được nạp sẵn.
    • Validate payloads thực theo schema để phát hiện breaking changes sớm.
    • Nếu bạn dùng schema composition nâng cao (ví dụ anyOf/oneOf/allOf), hãy kiểm tra kết quả bằng validator đầy đủ như Ajv.

Lưu ý về hỗ trợ keyword schema

Schema tạo ra có thể bao gồm $ref và có thể chỉnh sửa để thêm anyOf, oneOf, hoặc allOf. Với schema phức tạp, hãy dùng JSON Schema validator đầy đủ và dereference trước khi tạo mock nếu cần.

Công cụ JSON Schema & code generation liên quan

Dùng các công cụ này để validate schema, tạo mock payloads, định dạng JSON examples và giữ code/contract đồng bộ.

JSON Schema Mock Data Generator

Tạo JSON mẫu từ schema cho test, fixtures và tài liệu.

JSON Schema Validator

Validate JSON theo các schema keyword phổ biến và nhanh chóng tìm mismatch.

JSON → Ruby Classes

Tạo types và models Ruby từ JSON samples.

JSON → JSON Schema Generator

Tạo schema từ JSON sample đại diện để bổ sung cho schema kiểu model-first.

Schema Library

Khám phá ví dụ và pattern cho object, array, enums và constraints.

JSON Formatter

Làm sạch JSON examples trước khi validate theo schema hoặc chia sẻ tài liệu.

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

Hỗ trợ cấu trúc Ruby nào?

Parser tập trung vào classes expose attributes qua attr_reader/attr_accessor. Mỗi attribute trở thành một JSON Schema property. Methods và Ruby code khác sẽ bị bỏ qua, nên bạn có thể dán model classes đơn giản một cách an toàn.

Attributes được định kiểu thế nào?

Vì Ruby là ngôn ngữ động, attributes mặc định là `string` trong schema. Bạn có thể refine types bằng literal defaults; các cập nhật tương lai sẽ đọc type comments. Hiện tại công cụ cung cấp schema cấu trúc nhanh cho DTOs.

Vì sao nên dùng công cụ này?

Khi chia sẻ Ruby domain objects hoặc DTOs kiểu ActiveModel với team khác, JSON Schema giúp tài liệu hóa payloads và validate contracts. Công cụ chạy hoàn toàn trong trình duyệt.

Làm sao để tạo mock JSON payloads?

Sau khi tạo schema, nhấp "Generate Mock Data" để mở Mock Generator với schema đã nạp sẵn và tạo payload mẫu ngay lập tức.

Trình tạo JSON Schema từ Ruby Class | JSONSwiss