UrsaKit LogoUrsaKit

JSON Schema 產生器

一鍵從 JSON 資料產生 JSON Schema，支援嚴格模式並可下載結果，全程在瀏覽器內完成。

等待輸入

JSON Schema 輸出

輸入有效的 JSON，然後產生 Schema。

什麼是 JSON Schema 產生器？

JSON Schema 產生器會從範例文件推導出草稿結構描述：有哪些屬性、哪些是必填，以及每個值的型別。產生的結果是一份可以再手動收緊的契約起點。

面對大型 API 回應時，它省去最枯燥的第一輪型別標註，也讓你能拿具體內容和負責該傳輸內容的團隊討論。

如何產生 JSON Schema

  1. 貼上一段具代表性的 JSON 範例，內容越完整推導越準。
  2. 按「產生」，從解析後的文件建立結構描述。
  3. 檢查必填清單：範例中出現過的欄位會標為 required。
  4. 手動收緊限制，例如加上 pattern、enum 或數值範圍。
  5. 把結構描述下載成 .json 檔案，和 API 契約放在一起。

結構描述產生範例

簡單物件

{"id":1,"name":"ursa"}
{
  "type": "object",
  "properties": {
    "id": { "type": "integer" },
    "name": { "type": "string" }
  },
  "required": ["id", "name"]
}

巢狀陣列

{"tags":["a","b"]}
{
  "type": "array",
  "items": { "type": "string" }
}

自動產生與手寫結構描述的差異

比較項目從範例產生手寫
完成初稿所需時間幾秒數分鐘到數小時
準確度只反映範例反映預期契約
可為 null 的欄位範例沒出現就會漏掉明確標示
最適合快速建立契約起點長期維護的公開 API
常見問題

常見問題與規格

產生的是哪個版本的 JSON Schema？

會從你的資料推導出 draft 2020-12 結構描述，並關閉 additionalProperties。

我的 JSON 會被上傳嗎？

不會，結構描述是在你的瀏覽器內本機推導。

JSON Schema 產生器

  • 嚴格模式會把所有出現過的屬性都標為必填。
  • 產生的結構描述可下載為 draft 2020-12 文件。

全部工具