Cách dùng JSON Schema sang TypeScript
- Dán JSON Schema của bạn, hoặc đối tượng
components.schemascủa OpenAPI, vào khung bên trái. - Đặt tên kiểu gốc và chọn dùng
interfacehaytype. - Kiểu TypeScript sẽ cập nhật ngay khi bạn gõ; các định nghĩa trong
$defshoặcdefinitionssẽ trở thành kiểu có tên riêng. - Sao chép mã vào file
.tshoặc.d.ts.
Cách JSON Schema ánh xạ sang TypeScript
| JSON Schema | TypeScript |
|---|---|
"type": "string" / number, integer / boolean / null | string / number / boolean / null |
properties + required | interface với prop và thuộc tính tùy chọn prop? |
enum, const | union các literal: "draft" | "published" |
items, prefixItems | T[], tuple [A, B] |
additionalProperties (schema) | index signature [key: string]: T |
oneOf / anyOf / allOf | A | B / A | B / A & B |
$ref: "#/$defs/User" | kiểu có tên User |
"type": ["string", "null"] | string | null |
Các từ khóa chỉ dùng để kiểm tra như minLength, pattern hoặc format không có tương đương trong TypeScript; khi bật JSDoc, chúng sẽ được thêm vào chú thích. Các URL $ref bên ngoài sẽ được khai báo là unknown.
Muốn bắt đầu từ dữ liệu mẫu thay vì schema? Hãy dùng JSON sang TypeScript. Để kiểm tra dữ liệu theo schema, hãy dùng JSON Schema Validator.
Cũng được tìm dưới tên: chuyển json schema sang typescript, json schema to typescript, json schema to ts, tạo typescript từ json schema, openapi schema sang typescript, json schema sang interface, json schema converter.
Các công cụ dùng kèm tốt với JSON Schema sang TypeScript
- JSON sang JSON Schema — Dán một hoặc nhiều ví dụ JSON để nhận một JSON Schema mô tả chúng: đối tượng lồng nhau, mảng đối tượng được gộp thành một schema phần tử, các trường bắt buộc (khóa có mặt trong mọi ví dụ), định dạng được nhận diện như email, date-time, URI và UUID, enum tùy chọn, và đầu ra theo 2020-12 hoặc draft-07.
- JSON sang Types — Dán phản hồi API và nhận ngay model sẵn sàng sử dụng bằng 8 ngôn ngữ: TypeScript, Python (dataclass, TypedDict hoặc Pydantic), Go, Java, C#, Kotlin, Swift và Rust.
- Đị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.
Câu hỏi thường gặp
Làm sao để chuyển JSON Schema sang TypeScript?
Dán schema vào khung bên trái; các TypeScript interface sẽ hiện ở bên phải. Các định nghĩa trong $defs hoặc definitions sẽ trở thành kiểu có tên mà $ref trỏ tới.
Hỗ trợ những phiên bản JSON Schema nào?
Các từ khóa của draft-04 đến draft-07 và 2019-09/2020-12: properties, required, enum, const, items, prefixItems, additionalProperties, oneOf, anyOf, allOf, $ref, $defs và definitions.
Có dùng được cho schema của OpenAPI không?
Có. Bạn có thể dán một schema đơn lẻ hoặc toàn bộ đối tượng components.schemas để nhận một kiểu cho mỗi schema. Các tham chiếu #/components/schemas/ sẽ được xử lý.
Schema của tôi có bị tải lên máy chủ không?
Không. Quá trình chuyển đổi chạy hoàn toàn trên trình duyệt của bạn.
Tôi có thể cài JSON Schema sang TypeScript như một ứng dụng web và dùng khi không có mạng không?
Có. JSON Schema sang TypeScript là một ứng dụng web (PWA) có thể cài đặt — cài trực tiếp từ trình duyệt, không cần tải từ cửa hàng ứng dụng. Trên Chrome hoặc Edge (Windows, macOS, Linux, ChromeOS) hoặc Android, bấm Cài đặt ứng dụng ở đầu trang này; trên iPhone và iPad, dùng Chia sẻ → Thêm vào Màn hình chính; trên Mac, dùng File → Add to Dock trong Safari 17 trở lên. Sau đó ứng dụng mở trong cửa sổ riêng với biểu tượng riêng, và vì chạy hoàn toàn trên trình duyệt nên vẫn hoạt động khi không có mạng. Firefox trên máy tính không thể cài ứng dụng web. Cách cài đặt hoạt động thế nào.