從 JSON 等產生 Schema

建立 schema 時，Apidog 提供了一個非常實用的工具，可讓你從現有資料快速識別並建立 schema。點擊 Generate from JSON etc. 後，即可進入資料結構匯入工具。

在這裡，你可以貼上你的 JSON、XML、JSON Schema，以及使用 Import from Database，Apidog 會根據該資料自動產生 schema。

從 JSON/XML 產生

對於 JSON/XML，你只需要將現有的 JSON 或 XML 貼到指定區域，它就會被自動識別並轉換成對應的 schema 和資料型別。

重要注意事項

JSON 智慧識別用於根據提供的 JSON 產生資料結構，而不會儲存 JSON 本身包含的值。

JSON/XML 中出現的所有屬性都會被視為 required。

description 和 mock 等欄位將會留空。

覆寫模式

當第二次使用 Generated from JSON 產生 schema 時，新匯入的資料將覆寫已產生的現有 schema。在此情境中，有兩種 覆寫模式：

合併（預設）：當找到相符的 key 時，將保留原始 schema 中的 mock 和 description。

覆寫：所有現有資料都會被捨棄，新資料會完全取代舊資料。

命名風格

你可以選擇合適的命名風格：

Keep it as is

camelCase

PascalCase

snake_case

儲存為範例

在請求主體或回應中使用 Generate from JSON 時，啟用 Save as Example 會在產生 schema 時，將目前的 JSON/XML 納入為請求/回應範例。

從 JSON Schema 產生

只要貼上 JSON Schema，即可視覺化識別資料結構。

從資料庫匯入

Apidog 支援兩種從資料庫資料表產生 schema 的方法。第一種方法是直接連線到資料庫以讀取資料表結構；第二種方法則是貼上 SQL DDL 來識別資料表結構。

資料庫連線

若要從資料庫匯入 schema，請依照以下步驟操作：

設定資料庫連線。深入了解管理資料庫連線。

支援的資料庫

Apidog Free 支援 MySQL、SQL Server、Oracle 和 PostgreSQL 資料庫，而付費版本也包含對 ClickHouse、MongoDB 和 Redis 的支援。

在 Import from database 中選取資料庫連線。

選取要匯入的資料表。

設定匯入選項。如需特定設定，請參考前面關於 JSON/XML 處理的章節。

欄位長度設定

啟用 Follow database field length 切換開關時，Apidog 會根據資料表中定義的欄位長度，設定屬性的最小與最大長度值。

輸入 SQL (DDL)

貼上資料庫資料表的 CREATE 陳述式 (DDL) 以產生 schema。支援與 MySQL 相容的 SQL。

如需特定設定，請參考前面關於 JSON/XML 處理的章節。

從 JSON 等產生 Schema

從 JSON/XML 產生#

覆寫模式#

命名風格#

儲存為範例#

從 JSON Schema 產生#

從資料庫匯入#

資料庫連線#

輸入 SQL (DDL)#

從 JSON/XML 產生

覆寫模式

命名風格

儲存為範例

從 JSON Schema 產生

從資料庫匯入

資料庫連線

輸入 SQL (DDL)