JSON Schema 產生器

此 JSON Schema 產生器能將範例 JSON 轉換為可直接用於驗證器的 Schema，適用於 API、webhook、設定檔、資料管道和文件撰寫。只需貼入具有代表性的 JSON 物件、陣列或 NDJSON 摘要，並選擇推斷樣式，此工具即可建立包含巢狀屬性、陣列項目規則、可為 null 的值、範例以及逐路徑易讀備註的 schema。

為什麼要使用基於範例的 JSON Schema 產生器？

手動編寫 JSON Schema 雖然精確但速度較慢，特別是當資料包含巢狀物件、記錄陣列、選擇性欄位和可為 null 的值時。此產生器為您提供一個捕捉 JSON 資料觀察形狀的結構化初稿，並指出哪些地方仍需要人工審查。這對於 API 請求驗證、回應合約、OpenAPI 工作、webhook 載荷、事件流和設定 schema 非常有用。

如何使用

1. 將具有代表性的 JSON 物件、JSON 陣列或以換行符分隔的 JSON 記錄貼入範例編輯器中。
2. 選擇 JSON Schema 草案版本，並決定是否要推斷必填欄位、範例、enum 提示、字串格式和封閉物件。預設草案版本為 Draft 2020-12，每個物件的必填欄位設為出現在每個物件中，偵測格式、包含範例和推斷 enum 提示皆為開啟，封閉物件則為關閉。Schema 標題預設為 GeneratedSchema。
3. 點擊「生成 JSON Schema」以推斷型態、巢狀屬性、陣列項目、可為 null 的欄位和驗證提示。
4. 在開始使用 schema 之前，先檢查生成的結構圖，以查看每個路徑、推斷的型態、必填狀態、格式和規則。
5. 複製生成的 schema，並進一步調整特定領域的驗證規則，例如精確範圍、ID 模式和特定業務的 enum 值。

產生器推斷的內容

• 核心 JSON 型態：object、array、string、number、integer、boolean 和 null。
• 根據每個觀察到的物件中出現的內容，推斷巢狀物件屬性和必填欄位。
• 透過合併範例中觀察到的項目，推斷陣列項目 schema。
• 常見的字串格式，包括 email、URL、date、date-time、UUID、IPv4 和 IPv6。
• 選擇性的範例、enum 提示、觀察到的數字範圍和觀察到的字串長度。

常見問題（FAQ）

這個 JSON Schema 產生器有什麼功能？

它會讀取範例 JSON 並建立一個描述觀察到之資料外觀的 JSON Schema。此產生器能推斷物件屬性、陣列、基元型態、可為 null 的值、範例、enum 提示、必填欄位以及常見的字串格式。

生成的 schema 可以立即用於生產環境嗎？

建議將其作為一個強大的起點，然後再進行審查。範例資料無法得知所有的業務規則，因此您可能仍然需要手動添加模式（patterns）、精確範圍、允許的 enum 值、版本規則以及更嚴格的 additionalProperties 設定。

支援哪些 JSON Schema 草案版本？

此工具可以透過設定 $schema URI 來生成 Draft 2020-12、Draft 2019-09 和 Draft-07 的 schema。推斷出的結構刻意設計為與常見的驗證器相容。

必填欄位是如何推斷的？

當啟用必填欄位推斷時，只有當某個屬性出現在該層級之每個被觀察到的物件中，才會被標記為必填。對於物件陣列而言，這意味著該欄位必須出現在每個範例項目中。

此工具是否支援物件陣列和 NDJSON？

是的。最頂層的 JSON 陣列會被視為陣列 schema，而以換行符分隔的 JSON 記錄（NDJSON）則會被視為記錄陣列。項目屬性將會從觀察到的範例中進行合併。