从 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。

覆盖：所有现有数据都将被丢弃，新数据将完全替换旧数据。

命名风格

你可以选择合适的命名风格：

保持原样

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）