JSON 轉 TypeScript 型別
由 JSON 範例產生 TypeScript 型別(type Root = { ... };)。貼上 API 回應或設定檔,就能得到加上型別的起點。陣列元素的形狀不同時會合併成一個型別,只有部分元素才有的鍵會成為 email?: string 這樣的選用鍵。空陣列會成為 unknown[],含有 null 的值會成為 string | null 這類聯集型別。數字不論整數或小數都是 number,日期字串是 string,巢狀物件不另取名稱,以巢狀方式輸出。由於是從單一範例推論,是否必填、列舉與共用型別的拆分,請依規格自行調整。所有處理都在瀏覽器內完成,JSON 不會被傳送。
其他語言:Go、Python、Rust、Kotlin、C#
把上方的 JSON 轉成其他語言的型別:Go 結構(含 json 標籤)、Python TypedDict(3.11 以上)、Rust serde 結構、Kotlin data class(kotlinx.serialization)、C# 類別(System.Text.Json)。巢狀物件會成為具名型別,缺少的鍵會變成選填,資料不會傳送出去。
指南使用方式與特色
- 將 JSON 貼入上方輸入欄後點擊「轉換成 TypeScript」。
- 物件會整理成含型別的區塊,方便直接貼回程式碼。
- 陣列會判斷元素型別,若有多種類型則以聯集表示。
- 可使用複製或清除按鈕來重複利用或重新開始。
範例輸入與輸出範例
Generate TypeScript types
{"title":"Draft","tags":["dev","web"],"stats":{"views":1200}}type Root = {
title: string;
tags: string[];
stats: {
views: number;
};
};FAQ常見問題
會輸出什麼型別?
輸出 `type Root = { ... };` 形式的型別別名。巢狀物件不另取名稱,以巢狀方式輸出。若想改名或改成 `interface`,請自行修改。陣列元素的形狀不同時會怎樣?
會合併成一個型別。只有部分元素才有的鍵會成為 `email?: string` 這樣的選用鍵。只有值的種類不同時,才會出現 `string | number` 這類聯集型別。空陣列與 `null` 如何處理?
空陣列因無法得知元素型別而成為 `unknown[]`(不是 `any[]`)。含有 `null` 的值會成為 `string | null` 這類聯集型別。整數、小數、日期會被區分嗎?
不會。所有數字都是 `number`,日期字串也是 `string`,不會變成 `Date` 或 `bigint`。像 `my-key` 這種不能當識別字的鍵呢?
會加上引號輸出,例如 `"my-key": string;`。輸入的 JSON 會被傳送嗎?
不會。轉換完全在瀏覽器內進行。
使用情境常見的使用情境
快速建立型別定義
從後端回應範例產生 TypeScript 介面,快速展開具型別安全的實作。對齊資料契約
將共用的 JSON 轉成型別,釐清欄位名稱、選填旗標與結構的預期。輕量的審查片段
產生可貼在 PR 留言中的最小介面,讓討論聚焦在結構而非錯字。
注意注意事項與限制
是從單一範例推論的
型別只來自 JSON 中出現的值,不含「這其實是列舉」「這個鍵必填」之類的規格資訊。請務必確認內容。巢狀物件不會有名稱
輸出維持巢狀,因此重複出現的相同形狀不會合併成共用型別。需要時請自行拆出,例如 `type User = ...`。類似字典的 JSON 不會變成 `Record`
鍵會變動(如 ID)的物件,也只會成為含有所見鍵的型別。適合用 `Record<string, T>` 時請手動改寫。大整數會被四捨五入
JavaScript 數字無法精確表示的大整數,在讀入 JSON 時就會被四捨五入。ID 等請考慮以字串接收。
簡介關於此工具
JSON 轉 TypeScript 型別產生器
將 JSON 範例轉成 TypeScript type 或 interface,方便在 React、Next.js、Vue 等 TypeScript 專案中快速定義 API 回應、測試資料或 mock data 的型別。
常見用途
- 為 API 回應建立型別:從實際 payload 產生初稿。
- 文件化資料結構:將 JSON 結構轉成團隊更容易閱讀的型別。
- 快速原型開發:探索外部 API 時先建立基礎型別。
產生結果來自範例資料。optional field、null、混合陣列與錯誤回應仍需要手動檢查。
這個工具的相關文章
如何從 JSON 生成 TypeScript 型別:用實例學會轉換訣竅
將 API 回應的 JSON 轉換成型別安全的 TypeScript 介面,附實際轉換範例,涵蓋 null、陣列、巢狀、命名訣竅與手動微調,適合為既有 API 快速補上型別。
JSON 格式化與驗證:安全檢查 API 回應的方法
了解如何格式化 JSON、找出語法錯誤、確認值的型別,並將 API 回應延伸成 TypeScript 型別、Zod Schema 或 OpenAPI 文件,整理出實務上的完整流程。
JSON 生態系統入門:用實例串起格式化、型別生成、驗證與 API 定義
以一個 API 回應為例,用實際程式碼串起格式化、TypeScript 型別、Zod 執行期驗證與 OpenAPI 定義,讓你看清型別安全 API 開發的全貌。
