I-convert ang mga TypeScript type sa JSON!

Maglagay ng TypeScript interface para gumawa ng halimbawang JSON! Sinusuportahan ang TypeScript interface, type. Magagamit sa API docs at test request body (mock request body).
TypeScript
Resulta
 

I-convert ang mga TypeScript type sa JSON!

I-paste ang mga TypeScript interface, type alias, enum o class declaration at makakakuha ka ng halimbawang JSON document na tumutugon sa kanila. Sinusundan at pinupunan ang mga literal union, Record, mga utility type gaya ng Pick, Omit at Partial, at mga interface na pinagdudugtong gamit ang extends.

Gamitin ito bago pa magkaroon ng API para maghanda ng MSW o json-server mock data, gumawa ng Storybook props, o ipakita sa backend team kung anong hugis mismo ang gusto mong ipadala nila.

Paano gamitin

  1. I-paste ang mga type declaration mula sa isang file gaya ng types.ts. Puwedeng nakahalo ang export, import at mga function declaration; mga type declaration lang ang binabasa.
  2. Isama ang mga nire-reference na type at enum para mapunan sila. Nagiging null ang mga type name na wala sa input.
  3. Walang option. Ang unang object type na hindi nire-reference ng ibang declaration ang nagiging root, kaya ilagay sa unahan ang gusto mo; mas pinipili ang alias na pumupuno sa isang generic, gaya ng type UserPage = Page<User>, kaysa sa mismong generic declaration.
  4. Kopyahin ang resulta papunta sa HttpResponse.json(...) ng isang MSW handler, sa test fixture o sa Storybook args, saka ayusin ang mga value.

Halimbawa

Input (TypeScript)
type Channel = "email" | "sms" | "push";

enum Priority { Low = "low", High = "high" }

interface Notification {
  id: string;
  channel: Channel;
  priority: Priority;
  recipient: { userId: number; locale?: string };
  payload: Record<string, string>;
  readAt: Date | null;
  meta: Pick<Audit, "createdBy">;
}

interface Audit { createdBy: string; createdAt: Date }
Output (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

String literal union ang Channel, kaya kinukuha nito ang unang value na "email"; kinukuha ng string enum na Priority ang unang member value na "low". Nagiging object na may iisang "key" ang Record<string, string>, nare-resolve sa hindi-null na panig bilang ISO string ang Date | null, at ang napiling key lang ang pinapanatili ng Pick<Audit, "createdBy">. Kasama rin ang optional na locale?.

Mga sinusuportahang feature

  • Mga primitive: string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (ang format ng Date.toJSON()).
  • Ginagamit ng mga literal type ang value nila, kinukuha ng mga union ang unang member na hindi null/undefined, at pinagsasama ng mga intersection (A & B) at interface ... extends ang mga property.
  • Ginagamit ng enum ang value ng unang member nito, o 0 para sa numeric enum na walang initializer.
  • May isang sample element ang mga array, Array<T> at Set<T>; may value bawat posisyon ang mga tuple; nagiging {"key": V} ang Record<K, V>, Map at mga index signature.
  • Suportado ang mga utility type na Partial, Required, Readonly, NonNullable, Pick at Omit.
  • Wala sa JSON ang mga method at property na function ang type kaya tinatanggal sila; sa mga class, hindi kasama ang mga static field, get/set accessor at mga field na may @Exclude().
  • Pinuputol bilang empty array ang mga self-referencing array (children: TreeNode[]).

Mga gamit

Mga mock response para sa MSW o json-server

Bago pa handa ang backend, gumawa ng mock data mula sa mga API response type. Mauuna mong mabuo ang UI, at pareho pa rin ang mga type kapag lumipat ka sa totoong API mamaya.

Props para sa Storybook at mga test

Gumawa ng default na object mula sa props type ng isang component para sa story args o render data ng React Testing Library. Nandoon ang bawat required na property, kaya walang type error na hahabulin.

Pagkakasundo sa mga request format kasama ang backend

Gawing JSON ang isang frontend request type at i-paste ito sa isang API design doc o issue, para agad na mabasa ang istruktura ng mga backend developer na hindi gumagamit ng TypeScript.

Mga paalala at limitasyon

  • Laging kasama ang mga optional na property (?); ikaw na ang magbura ng mga key para i-test ang mga response na wala sila.
  • Pinapalitan ang mga generic parameter kung saan ginagamit ang type: sa type UserPage = Page<User>, pinupunan ng User ang items: T[], at ina-apply ang mga default gaya ng <T = string> kapag walang ibinigay na argument. Hindi pa rin ini-evaluate ang mga conditional type sa loob ng mga generic.
  • Hindi ini-evaluate ang mga indexed access type gaya ng T["key"], mga conditional type at mga template literal type.
  • Ginagamit ng class field na may iisang literal na initializer (name = "kim", retries = 3) ang value na iyon; pahiwatig lang sa type ang ibang initializer gaya ng new Date().
  • Hindi binabasa ang runtime schema code gaya ng Zod o io-ts; isulat bilang simpleng interface ang type na ini-infer ng z.infer.
  • Ipinapakita bilang object at array ang Map at Set, pero ginagawang {} ng JSON.stringify ang dalawa, kaya mas mainam ang Record o mga array sa mga response type.

Mga madalas itanong

Tama bang lumalabas na string ang Date?

Oo. Pinapalitan ng JSON.stringify ang isang Date ng resulta ng toJSON() nito, isang ISO 8601 string. String pa rin ang natatanggap ng kabilang panig, kaya lagyan ito ng type na string o i-parse ito.

Anong value ang nakukuha ng union gaya ng status: "active" | "inactive"?

Ang unang literal ayon sa pagkakasunod ng declaration, "active". Ayusin ang pagkakasunod ng union kung mas gusto mong ipakita ang ibang value.

Gumagana ba ito sa mga NestJS DTO class?

Pina-parse ang mga class declaration at decorator, kaya maayos na nako-convert ang mga DTO na may class-validator decorator, at hindi isinasama ang mga field na may @Exclude() ng class-transformer.

Paano ako pupunta mula JSON papuntang TypeScript type?

Gamitin ang page na JSON → TypeScript para sa kabaligtarang direksyon. May hiwalay ring mga page na gumagawa ng JSON mula sa mga TypeORM, Sequelize at Mongoose model.