Tukar JSON kepada jenis TypeScript!

Masukkan JSON untuk menukarnya kepada interface TypeScript! Menyokong TypeScript interface. TypeORM · Sequelize · Mongoose ada dalam tab di atas.
JSON
Hasil
 

Tukar JSON kepada jenis TypeScript!

Alat ini membaca nilai JSON dan menulis pengisytiharan interface TypeScript untuknya. Kunci dikekalkan tepat seperti asal; tatasusunan objek digabungkan menjadi satu interface, kunci yang hanya ada dalam sesetengah item mendapat ?, dan nilai bercampur menjadi union type.

Gunakannya untuk memberi jenis kepada respons fetch atau axios di frontend, mengisytiharkan jenis pulangan bagi API route Next.js atau handler Express, atau apabila backend hanya mendokumentasikan contoh respons tanpa definisi jenis.

Cara menggunakan

  1. Tampal JSON respons, contohnya yang disalin dari tab Network dalam DevTools.
  2. Masukkan nama interface akar dalam Nama jenis (contohnya ChannelHistory); ia disimpan dalam URL sebagai ?name=.
  3. Simpan output ke fail seperti types.ts dan gunakannya melalui import type { ChannelHistory } from "./types".

Contoh

Input (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
}
Output (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;
}

Kedua-dua mesej digabungkan menjadi satu interface Message; reactions, edited dan attachment hanya muncul dalam salah satu daripadanya, jadi ia mendapat ?. text bercampur antara rentetan dan null, menghasilkan string | null. Interface elemen mengambil bentuk tunggal kunci (messages → Message).

Ciri yang disokong

  • Setiap pengisytiharan ialah export interface, sedia untuk diimport di tempat lain.
  • Kunci JSON tidak dinamakan semula, jadi jenis sepadan satu-dengan-satu dengan objek respons; kunci yang bukan pengecam sah ("a-b", "2fa") diletakkan dalam petikan.
  • Tatasusunan objek menggabungkan kunci daripada setiap elemen; kunci yang tiada dalam sesetengah elemen menjadi pilihan (?:).
  • Jenis bercampur menghasilkan union (string | number); null ditambah paling akhir sebagai | null. Tatasusunan bercampur menjadi (string | number)[].
  • Tatasusunan kosong tiada jenis elemen untuk disimpulkan dan menjadi unknown[].
  • Tatasusunan peringkat atas turut menghasilkan alias seperti export type Root = RootItem[];.

Kes penggunaan

Memberi jenis kepada respons fetch dan axios

Hantar jenis sebagai generic, contohnya const res = await axios.get<ChannelHistory>(url), dan editor akan memberi amaran bahawa res.data.messages[0].text mungkin null.

API pihak ketiga tanpa typing

Bagi API dalaman atau luaran tanpa SDK atau pakej @types, satu sampel respons sudah cukup untuk menghasilkan fail definisi jenis untuk dikongsi dengan pasukan.

Data mock dan props komponen

Jana interface daripada JSON mock Storybook atau ujian dan gunakannya sebagai jenis props komponen; apabila mock tidak lagi selari dengan komponen, compiler akan memberitahu anda.

Nota dan had

  • Interface dihapuskan semasa kompil dan tidak menyemak pada masa jalan sama ada respons benar-benar berbentuk begitu. Gandingkan dengan pustaka skema seperti zod jika anda perlukan validasi masa jalan.
  • Semua nombor ialah number (tiada pemisahan integer/float), dan rentetan tarikh ialah string.
  • Medan dengan set nilai tetap, seperti "status": "active", dijana sebagai string; sempitkan sendiri kepada literal union ("active" | "banned").
  • Bentuk yang sama di bawah kunci berbeza masing-masing mendapat interface sendiri, dan nama yang bertembung diberi akhiran nombor seperti Profile2.

Soalan lazim

Bolehkah saya mendapat alias type dan bukan interface?

Alias type hanya digunakan untuk tatasusunan atau primitif peringkat atas; objek sentiasa interface. Menulis semula export interface X { ... } sebagai export type X = { ... }; berkelakuan sama untuk tujuan ini.

Mengapa pilihan (?) dan | null diasingkan?

Maksudnya berbeza: ? bermaksud kunci mungkin tiada (undefined), manakala | null bermaksud kunci itu ada dengan nilai null. Dengan strictNullChecks dihidupkan, anda mengendalikan kedua-dua kes secara berbeza.

Mengapa kunci tidak ditukar kepada camelCase?

Jenis TypeScript menerangkan objek sebenar, jadi kunci yang dinamakan semula tidak lagi sepadan dengan respons. Jika anda mahukan camelCase dalam kod, takrifkan jenis berasingan untuk hasil fungsi pemetaan anda.

Saya perlukan entity ORM (TypeORM, Sequelize, Mongoose).

Halaman ini hanya menjana pengisytiharan jenis biasa. Tab TypeORM, Sequelize dan Mongoose di bahagian atas menjana kod entity dan model daripada JSON yang sama.