Chuyển JSON thành kiểu TypeScript!

Nhập JSON để chuyển thành interface TypeScript! Hỗ trợ TypeScript interface. TypeORM · Sequelize · Mongoose ở các tab phía trên.
JSON
Kết quả
 

Chuyển JSON thành kiểu TypeScript!

Công cụ này đọc một giá trị JSON và viết khai báo interface TypeScript cho nó. Key được giữ đúng như cũ; mảng object được gộp thành một interface, key chỉ có ở một số phần tử nhận ?, và giá trị lẫn lộn thành union type.

Dùng nó để khai báo kiểu cho response của fetch hay axios ở frontend, khai báo kiểu trả về cho API route của Next.js hay handler Express, hoặc bất cứ khi nào backend chỉ ghi tài liệu response mẫu mà không có định nghĩa kiểu.

Cách sử dụng

  1. Dán một JSON response, ví dụ sao chép từ tab Network của DevTools.
  2. Nhập tên interface gốc vào Tên kiểu (ví dụ ChannelHistory); nó được giữ trong URL dưới dạng ?name=.
  3. Lưu output vào file như types.ts và dùng qua import type { ChannelHistory } from "./types".

Ví dụ

Đầu vào (JSON)
{
  "channel": "general",
  "messages": [
    { "id": "m1", "user": "kim", "text": "deploy done", "reactions": ["+1"] },
    { "id": "m2", "user": "lee", "text": null, "edited": true, "attachment": { "type": "image", "url": "https://cdn.example.com/a.png" } }
  ],
  "cursor": 42
}
Đầu ra (TypeScript)
export interface ChannelHistory {
  channel: string;
  messages: Message[];
  cursor: number;
}

export interface Message {
  id: string;
  user: string;
  text: string | null;
  reactions?: string[];
  edited?: boolean;
  attachment?: Attachment;
}

export interface Attachment {
  type: string;
  url: string;
}

Hai tin nhắn được gộp thành một interface Message; reactions, edited và attachment chỉ có ở một trong hai nên nhận ?. text trộn chuỗi và null, cho ra string | null. Interface phần tử lấy dạng số ít của key (messages → Message).

Tính năng hỗ trợ

  • Mọi khai báo đều là export interface, sẵn sàng import ở nơi khác.
  • Key JSON không bị đổi tên, nên kiểu khớp một-một với object response; key không phải định danh hợp lệ ("a-b", "2fa") được đặt trong dấu nháy.
  • Mảng object gộp key từ mọi phần tử; key thiếu ở một số phần tử thành tùy chọn (?:).
  • Kiểu lẫn lộn tạo ra union (string | number); null được nối vào cuối thành | null. Mảng lẫn lộn thành (string | number)[].
  • Mảng rỗng không có kiểu phần tử để suy ra nên thành unknown[].
  • Mảng ở cấp cao nhất còn tạo thêm alias như export type Root = RootItem[];.

Trường hợp sử dụng

Khai báo kiểu cho response của fetch và axios

Truyền kiểu làm generic, ví dụ const res = await axios.get<ChannelHistory>(url), và editor sẽ cảnh báo rằng res.data.messages[0].text có thể là null.

API bên thứ ba không có typing

Với API nội bộ hay bên ngoài không có SDK hoặc package @types, một response mẫu là đủ để tạo file định nghĩa kiểu chia sẻ cho cả đội.

Dữ liệu giả và props của component

Tạo interface từ JSON giả của Storybook hay test rồi dùng làm kiểu props của component; khi dữ liệu giả lệch khỏi component, compiler sẽ báo cho bạn.

Lưu ý và giới hạn

  • Interface bị xóa lúc compile và không kiểm tra lúc runtime xem response có đúng hình dạng đó không. Hãy kết hợp với thư viện schema như zod nếu cần validate lúc runtime.
  • Mọi số đều là number (không tách số nguyên/số thực), và chuỗi ngày tháng là string.
  • Field có tập giá trị cố định, như "status": "active", ra dạng string; hãy tự thu hẹp thành literal union ("active" | "banned").
  • Các hình dạng giống nhau dưới những key khác nhau đều có interface riêng, và tên bị trùng nhận hậu tố số như Profile2.

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

Có lấy được alias type thay vì interface không?

Alias type chỉ được dùng cho mảng hoặc giá trị nguyên thủy ở cấp cao nhất; object luôn là interface. Viết lại export interface X { ... } thành export type X = { ... }; cho hành vi như nhau trong trường hợp này.

Vì sao tùy chọn (?) và | null được tách riêng?

Chúng mang nghĩa khác nhau: ? nói rằng key có thể vắng mặt (undefined), còn | null nói rằng key có mặt với giá trị null. Khi bật strictNullChecks, bạn xử lý hai trường hợp này theo cách khác nhau.

Vì sao key không được chuyển sang camelCase?

Kiểu TypeScript mô tả object thực tế, nên key bị đổi tên sẽ không còn khớp với response. Nếu muốn dùng camelCase trong code, hãy định nghĩa một kiểu riêng cho kết quả của hàm mapping.

Tôi cần entity ORM (TypeORM, Sequelize, Mongoose).

Trang này chỉ xuất khai báo kiểu thuần. Các tab TypeORM, Sequelize và Mongoose ở phía trên tạo code entity và model từ cùng một JSON.