แปลง JSON เป็นไทป์ TypeScript!

ป้อน JSON เพื่อแปลงเป็น interface ของ TypeScript! รองรับ TypeScript interface TypeORM · Sequelize · Mongoose อยู่ในแท็บด้านบน
JSON
ผลลัพธ์
 

แปลง JSON เป็นไทป์ TypeScript!

เครื่องมือนี้อ่านค่า JSON แล้วเขียนการประกาศ interface ของ TypeScript ให้ คีย์ถูกเก็บไว้ตรงตามเดิม อาร์เรย์ของออบเจ็กต์ถูกรวมเป็น interface เดียว คีย์ที่มีแค่ในบางรายการจะได้ ? และค่าที่ไทป์ปนกันจะกลายเป็น union type

ใช้กำหนดไทป์ให้ response ของ fetch หรือ axios ฝั่ง frontend ประกาศไทป์ที่คืนจาก API route ของ Next.js หรือ handler ของ Express หรือเมื่อ backend มีแค่ตัวอย่าง response ในเอกสารแต่ไม่มีนิยามไทป์

วิธีใช้

  1. วาง JSON ของ response เช่นที่คัดลอกมาจากแท็บ Network ใน DevTools
  2. ใส่ชื่อ interface รากใน ชื่อไทป์ (เช่น ChannelHistory) ค่านี้ถูกเก็บใน URL เป็น ?name=
  3. บันทึกผลลัพธ์ลงไฟล์อย่าง types.ts แล้วใช้งานผ่าน import type { ChannelHistory } from "./types"

ตัวอย่าง

อินพุต (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
}
เอาต์พุต (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;
}

ข้อความทั้งสองถูกรวมเป็น interface Message เดียว reactions, edited และ attachment มีแค่ในข้อความเดียว จึงได้ ? ส่วน text มีทั้งสตริงและ null จึงได้ string | null interface ของสมาชิกใช้รูปเอกพจน์ของคีย์ (messages → Message)

ฟีเจอร์ที่รองรับ

  • ทุกการประกาศเป็น export interface พร้อม import ไปใช้ที่อื่น
  • คีย์ JSON ไม่ถูกเปลี่ยนชื่อ ไทป์จึงตรงกับออบเจ็กต์ของ response แบบหนึ่งต่อหนึ่ง คีย์ที่ไม่ใช่ identifier ที่ถูกต้อง ("a-b", "2fa") จะถูกใส่เครื่องหมายคำพูด
  • อาร์เรย์ของออบเจ็กต์รวมคีย์จากทุกสมาชิก คีย์ที่ขาดไปในบางสมาชิกจะเป็น optional (?:)
  • ไทป์ที่ปนกันได้ union (string | number) และ null ถูกต่อท้ายสุดเป็น | null อาร์เรย์ที่ไทป์ปนกันเป็น (string | number)[]
  • อาร์เรย์ว่างไม่มีไทป์ของสมาชิกให้อนุมาน จึงเป็น unknown[]
  • อาร์เรย์ระดับบนสุดจะได้ alias เพิ่มด้วย เช่น export type Root = RootItem[];

กรณีการใช้งาน

กำหนดไทป์ให้ response ของ fetch และ axios

ส่งไทป์เป็น generic เช่น const res = await axios.get<ChannelHistory>(url) แล้วเอดิเตอร์จะเตือนว่า res.data.messages[0].text อาจเป็น null

API ภายนอกที่ไม่มี typing

สำหรับ API ภายในหรือภายนอกที่ไม่มี SDK หรือแพ็กเกจ @types แค่ response ตัวอย่างเดียวก็พอจะสร้างไฟล์นิยามไทป์ไว้แชร์ในทีม

mock data และ props ของคอมโพเนนต์

สร้าง interface จาก mock JSON ของ Storybook หรือเทสต์ แล้วใช้เป็นไทป์ props ของคอมโพเนนต์ เมื่อ mock กับคอมโพเนนต์ไม่ตรงกัน คอมไพเลอร์จะบอกคุณ

ข้อควรระวังและข้อจำกัด

  • interface ถูกลบทิ้งตอนคอมไพล์ และไม่ได้ตรวจตอนรันว่า response มีรูปร่างแบบนั้นจริง ถ้าต้องการ validation ตอนรัน ให้ใช้คู่กับไลบรารี schema อย่าง zod
  • ตัวเลขทั้งหมดเป็น number (ไม่แยกจำนวนเต็ม/ทศนิยม) และสตริงวันที่เป็น string
  • ฟิลด์ที่มีชุดค่าตายตัวอย่าง "status": "active" ออกมาเป็น string ให้จำกัดเป็น literal union ("active" | "banned") เอง
  • รูปร่างเหมือนกันที่อยู่ใต้คีย์ต่างกันจะได้ interface ของตัวเองแยกกัน และชื่อที่ชนกันจะได้ตัวเลขต่อท้ายอย่าง Profile2

คำถามที่พบบ่อย

ขอเป็น alias แบบ type แทน interface ได้ไหม?

alias แบบ type ใช้เฉพาะกับอาร์เรย์หรือค่า primitive ระดับบนสุด ส่วนออบเจ็กต์เป็น interface เสมอ การเขียน export interface X { ... } ใหม่เป็น export type X = { ... }; ให้ผลเหมือนกันสำหรับจุดประสงค์นี้

ทำไม optional (?) กับ | null ถึงแยกกัน?

ความหมายต่างกัน: ? บอกว่าคีย์อาจไม่มี (undefined) ขณะที่ | null บอกว่าคีย์มีอยู่แต่ค่าเป็น null เมื่อเปิด strictNullChecks คุณต้องจัดการสองกรณีนี้ต่างกัน

ทำไมคีย์ไม่ถูกแปลงเป็น camelCase?

ไทป์ของ TypeScript อธิบายออบเจ็กต์จริง ถ้าเปลี่ยนชื่อคีย์ก็จะไม่ตรงกับ response อีกต่อไป ถ้าอยากใช้ camelCase ในโค้ด ให้นิยามไทป์แยกสำหรับผลลัพธ์ของฟังก์ชันที่แปลงค่า

ต้องการ entity ของ ORM (TypeORM, Sequelize, Mongoose)

หน้านี้สร้างเฉพาะการประกาศไทป์ธรรมดา แท็บ TypeORM, Sequelize และ Mongoose ด้านบนจะสร้างโค้ด entity และโมเดลจาก JSON เดียวกัน