JSON 轉 TypeScript
從 JSON 物件產生 TypeScript 介面定義。巢狀物件轉為命名介面,陣列推論元素型別,陣列項目間缺少的鍵自動標記為選填屬性。
input.json
types.ts
相關
與 TS Types 相關的指南
JSON 轉 TypeScript 的運作方式
每個 JSON 物件都會生成一個 TypeScript interface。根物件預設命名為 Root。巢狀物件會依對應的屬性鍵生成各自的具名介面 —— 名為 address 的鍵會得到一個 Address 介面。
陣列與可選欄位
物件陣列會合併所有元素中出現過的鍵。若某些項目缺少某個鍵,它就會變成可選屬性(key?: Type)。原始型別的陣列會得到帶型別的簽章,例如 string[] 或 number[]。
什麼時候用它
- API 接入 —— 貼上回應主體,立刻得到可放進 TypeScript 專案的型別定義
- 原型階段 —— 在著手解析邏輯之前,先快速搭起對新 API 或資料集的介面骨架
- 程式碼審查 —— 確認 JSON 負載的形狀與程式期待的介面一致