数据模型 / 数据结构

Apifox 中的“数据结构”功能和编程语言里的数据结构概念类似，主要用于接口设计场景中的“返回响应”和 json / xml 类型的“Body 参数”。

选择该数据字段是否为必填项。

调整选择字段的数据类型。同时你还可以编辑该字段的“Mock 设置”，详细语法说明请阅读《Mock 语法》。

新增或删除字段。

拖拽移动并改变字段之间的排序。

除了手动填写数据结构来编写数据结构外，还支持通过 JSON、XML、JSON Schema、数据库、Mockjs 自动化批量生成数据结构。你可以在请求参数及返回响应中，点击“通过 JSON 等生成”按钮进行快捷导入。

你可以输入 JSON 格式代码生成数据结构。

JSON 智能识别的作用只是生成数据结构，并不会将 JSON 里的值保存下来。Apifox 在 2.1.39 版本之后，JSON 智能识别功能支持识别“注释”字段，并写入说明。

轻点 XML 页，输入 XML 格式代码生成数据结构。

轻点 JSON Schema 页，输入 JSON 格式代码生成数据结构。

支持从数据库中导入并自动生成 API 文档中的数据结构。

1. 通过数据库连接

点击任意接口中的“修改文档”，然后轻点数据结构中的“通过 JSON 等生成”按钮。

切换至“从数据库导入” tab 页，然后轻点“新建”按钮。选择目标数据库类型，填写对应的数据库信息后点击“保存”。

为了提高安全性，数据库地址、端口、用户名、 密码、数据库名 仅存储在本地电脑，不会同步到云端。团队成员之间的数据库也不会相互同步，每位成员都需要自行手动设置数据库。

2. 选择数据库

在左侧目录中选择目标数据库，然后预览区将会显示从数据库中读取到的数据。在导入的过程中你还可以选择调整覆盖模式（智能合并或完全覆盖）、命名风格转换（保持原样或大小驼峰）以及注释写入。

当数据结构中已经存在 mock、中文名、说明时，推荐使用智能合并。当导入相同字段时，新导入的部分不会覆盖原有的 mock、中文名、说明等数据。

3. 插入数据结构

确认数据后，点击“确定”按钮即可将数据结构插入至数据结构中。点击示例中的“自动生成”按钮还可以基于数据结构生成详细的返回响应示例。

你也可以在“输入建表 SQL(DDL)” tab 页中输入 SQL 建表语句，读取数据库字段长度，写入字段属性。在插入命令至数据库的同时生成 API 文档中的数据结构。

轻点 Mockjs 页，输入 mockjs 语法代码生成数据结构。

数据模型是团队中可复用的“数据结构”。设计数据结构时可以在“数据类型”中直接选择已定义的“数据模型”。

在使用"数据模型"功能之前，需要先建立可复用的"数据结构"。根据项目需要，可以先在“数据模型”下新建“数据结构”。各数据模型间支持相互引用。

在接口文档页的“返回响应”和 json / xml 类型的“Body 参数”处，在“数据类型”中引用已经建立好的“数据模型”。

若当前引用的数据模型不符合要求，可以直接跳转到“数据模型”中进行修改。

若当前接口仅需部分引用“数据模型”，你可以直接进行修改，并且无需担心这会影响原“数据模型”。

或后续点击“恢复关联”按钮。

支持引用多个“数据模型“，并且还可以通过拖拽调整“数据模型”之间排序。

根据设计的数据结构，与 Mock 功能，你可以直接预览请求响应的数据。详细说明请参考文档《Mock 功能简介》。

根据数据结构生成各种语言的代码，更多信息请查看文档：《自动生成调试代码》。

Apifox 的数据结构和数据模型完全遵守 JSON Schema 规范，所以你也可以直接编辑 JSON Schema 的方式定义数据结构。

参考文档：《JSON Schema 介绍》。