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

Đầu vào: Python code

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

Đầu ra: JSON Schema

Cài đặt

Chọn class/dataclass/BaseModel nào sẽ được dùng làm 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 Python classes để tạo JSON Schema ngay lập tức.

Hỗ trợ dataclasses, BaseModel classes, enums, TypedDicts và cú pháp type-hint hiện đại.

Cách chuyển Python dataclasses, Pydantic models và TypedDicts sang JSON Schema – hướng dẫn từng bước

Công cụ Python 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 Python

    • 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 model (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ấu trúc Python nào?

Công cụ hiểu regular classes, dataclasses, Pydantic BaseModel classes và TypedDict definitions. Nó đọc field annotations, default values, Optional/Union hints, Literal values và Enum subclasses để tạo JSON Schema chính xác mà không upload code.

Type detection hoạt động thế nào trong Python?

Type hints như list[str], dict[str, Any], Optional[int], tuple[float, float] và custom classes/enums được map sang JSON Schema primitives/arrays/objects/references tự động. Khi thiếu annotations, công cụ fallback từ default values và hiển thị cảnh báo để bạn biết cần chỉnh gì.

Có hỗ trợ các phiên bản/framework Python khác nhau không?

Có. Hỗ trợ cú pháp hiện đại như PEP 585 generic types, PEP 604 unions (str | None) và decorators như @dataclass(frozen=True) hoặc @validator. Nó cũng xử lý typing.Optional/typing.List nên code Python 3.7+ hoạt động ngay.

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

Sau khi tạo schema, dùng shortcut "Generate Mock Data" để mở Mock Generator với schema đã nạp sẵn. Cấu hình locale, số lượng array và tạo payload mẫu phù hợp cho docs hoặc tests.

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