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

Đầu vào: TypeScript code

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

Đầu ra: JSON Schema

Cài đặt

Chọn interface/type 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 TypeScript types để tạo JSON Schema ngay lập tức.

Hỗ trợ interfaces, type aliases, public class fields, optional/readonly modifiers và union types.

Cách chuyển TypeScript interfaces, types và classes sang JSON Schema – hướng dẫn từng bước

Công cụ TypeScript interface → 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 TypeScript

    • 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 type (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 $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ộ.

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

Hỗ trợ cú pháp TypeScript nào?

Parser hỗ trợ interfaces, type aliases và classes với public fields. Hỗ trợ optional properties, readonly modifiers, string-literal keys, union types, arrays, Record types và nested references. Comments và decorators bị bỏ qua nên bạn có thể dán DTOs trực tiếp từ dự án.

Type mapping hoạt động như thế nào?

Primitive types (string, number, boolean, bigint, Date) map sang JSON Schema primitives với formats phù hợp. Arrays, Record<string, T> và shapes kiểu dictionary trở thành schema arrays/objects. Union types bao gồm null/undefined sẽ tự động đánh dấu field optional.

Tôi có thể dùng cho classes lẫn interfaces không?

Có. Miễn là class định nghĩa public fields (hoặc readonly properties) với type annotations, nó sẽ được chuyển thành JSON Schema. Tất cả chạy trong trình duyệt nên code không rời khỏi máy.

Làm sao để lấy mock JSON từ schema?

Sau khi tạo schema, nhấp "Generate Mock Data" để mở Mock Generator với schema đã nạp sẵn. Cấu hình locale, kích thước array và fields optional để tạo payload mẫu ngay lập tức.

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