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

ป้อน interface ของ TypeScript เพื่อสร้าง JSON ตัวอย่าง! รองรับ TypeScript interface, type เหมาะสำหรับเอกสาร API และ request body สำหรับทดสอบ (mock request body)
TypeScript
ผลลัพธ์
 

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

วางการประกาศ interface, type alias แบบ type, enum หรือคลาสของ TypeScript แล้วจะได้ JSON ตัวอย่างที่ตรงตามไทป์นั้น literal union, Record utility type อย่าง Pick, Omit และ Partial รวมถึง interface ที่ต่อกันด้วย extends จะถูกตามไปเติมค่าทั้งหมด

ใช้ก่อนที่ API จะมีอยู่จริงเพื่อเตรียม mock data สำหรับ MSW หรือ json-server สร้าง props ของ Storybook หรือแสดงให้ทีม backend เห็นชัดว่าต้องการให้ส่งรูปร่างแบบไหน

วิธีใช้

  1. วางการประกาศไทป์จากไฟล์อย่าง types.ts มี export, import และการประกาศฟังก์ชันปนอยู่ได้ จะอ่านเฉพาะการประกาศไทป์
  2. ใส่ไทป์และ enum ที่ถูกอ้างถึงไว้ด้วยเพื่อให้ถูกเติมค่า ชื่อไทป์ที่ไม่อยู่ในอินพุตจะเป็น null
  3. ไม่มีตัวเลือกให้ตั้ง ไทป์ออบเจ็กต์ตัวแรกที่ไม่มีการประกาศอื่นอ้างถึงจะเป็นราก จึงควรวางตัวที่ต้องการไว้ก่อน alias ที่เติม generic อย่าง type UserPage = Page<User> จะถูกเลือกก่อนการประกาศ generic เอง
  4. คัดลอกผลลัพธ์ไปใส่ใน HttpResponse.json(...) ของ handler ใน MSW, test fixture หรือ args ของ Storybook แล้วปรับค่า

ตัวอย่าง

อินพุต (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 }
เอาต์พุต (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

Channel เป็น string literal union จึงใช้ค่าแรก "email" และ string enum Priority ใช้ค่าของสมาชิกตัวแรก "low" Record<string, string> กลายเป็นออบเจ็กต์ที่มี "key" ตัวเดียว Date | null เลือกฝั่งที่ไม่ใช่ null เป็นสตริง ISO และ Pick<Audit, "createdBy"> เก็บไว้แค่คีย์ที่เลือก locale? ที่เป็น optional ก็ถูกรวมไว้ด้วย

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

  • primitive: string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (รูปแบบของ Date.toJSON())
  • literal type ใช้ค่าของมัน union ใช้สมาชิกตัวแรกที่ไม่ใช่ null/undefined และ intersection (A & B) กับ interface ... extends จะรวมพร็อพเพอร์ตี
  • enum ใช้ค่าของสมาชิกตัวแรก หรือ 0 สำหรับ numeric enum ที่ไม่มี initializer
  • อาร์เรย์ Array<T> และ Set<T> ได้สมาชิกตัวอย่างหนึ่งตัว tuple ได้ค่าตามแต่ละตำแหน่ง Record<K, V>, Map และ index signature กลายเป็น {"key": V}
  • รองรับ utility type Partial, Required, Readonly, NonNullable, Pick และ Omit
  • เมธอดและพร็อพเพอร์ตีที่เป็นฟังก์ชันไม่มีใน JSON จึงถูกตัดออก ในคลาส ฟิลด์ static accessor get/set และฟิลด์ @Exclude() ถูกตัดออก
  • อาร์เรย์ที่อ้างถึงตัวเอง (children: TreeNode[]) ถูกตัดเป็นอาร์เรย์ว่าง

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

mock response สำหรับ MSW หรือ json-server

ก่อนที่ backend จะพร้อม ให้สร้าง mock data จากไทป์ของ response ของ API สร้าง UI ไปก่อนได้ และเมื่อเปลี่ยนไปใช้ API จริงภายหลังก็ยังใช้ไทป์เดิม

props สำหรับ Storybook และเทสต์

สร้างออบเจ็กต์ค่าเริ่มต้นจากไทป์ props ของคอมโพเนนต์ สำหรับ args ของ story หรือข้อมูล render ของ React Testing Library ทุกพร็อพเพอร์ตีที่จำเป็นมีครบ จึงไม่มี type error ให้ตามแก้

ตกลงรูปแบบ request กับ backend

แปลงไทป์ request ของ frontend เป็น JSON แล้ววางลงในเอกสารออกแบบ API หรือ issue นักพัฒนา backend ที่ไม่ได้ใช้ TypeScript ก็อ่านโครงสร้างได้ทันที

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

  • พร็อพเพอร์ตี optional (?) ถูกรวมไว้เสมอ ถ้าจะทดสอบ response ที่ไม่มีคีย์เหล่านั้น ให้ลบคีย์เอง
  • generic parameter ถูกแทนที่ตรงที่ใช้ไทป์: กับ type UserPage = Page<User> ค่า items: T[] จะถูกเติมด้วย User และค่าเริ่มต้นอย่าง <T = string> มีผลเมื่อไม่ได้ส่งอาร์กิวเมนต์ แต่ conditional type ภายใน generic ยังไม่ถูกประมวลผล
  • indexed access type อย่าง T["key"], conditional type และ template literal type ไม่ถูกประมวลผล
  • ฟิลด์ของคลาสที่ initialize ด้วย literal ตัวเดียว (name = "kim", retries = 3) ใช้ค่านั้น initializer อื่นอย่าง new Date() ใช้แค่เป็นเบาะแสของไทป์
  • ไม่อ่านโค้ด schema ตอนรันอย่าง Zod หรือ io-ts ให้เขียนไทป์ที่ z.infer อนุมานได้ออกมาเป็น interface ธรรมดา
  • Map และ Set แสดงเป็นออบเจ็กต์และอาร์เรย์ แต่ JSON.stringify เปลี่ยนทั้งคู่เป็น {} ในไทป์ของ response จึงควรใช้ Record หรืออาร์เรย์

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

Date ออกมาเป็นสตริงถูกต้องแล้วหรือ?

ถูกต้อง JSON.stringify แทน Date ด้วยผลของ toJSON() ซึ่งเป็นสตริง ISO 8601 ฝั่งรับก็ได้สตริงเช่นกัน จึงควรกำหนดไทป์เป็น string หรือพาร์สเอง

union อย่าง status: "active" | "inactive" ได้ค่าไหน?

literal ตัวแรกตามลำดับการประกาศคือ "active" ถ้าอยากแสดงค่าอื่น ให้สลับลำดับใน union

ใช้กับคลาส DTO ของ NestJS ได้ไหม?

การประกาศคลาสและ decorator ถูกพาร์สได้ DTO ที่ติด decorator ของ class-validator จึงแปลงได้ปกติ และฟิลด์ @Exclude() ของ class-transformer ถูกตัดออก

จะแปลงจาก JSON ไปเป็นไทป์ TypeScript อย่างไร?

ใช้หน้า JSON → TypeScript สำหรับทิศทางตรงกันข้าม และยังมีหน้าแยกที่สร้าง JSON จากโมเดลของ TypeORM, Sequelize และ Mongoose