跳到主要内容

数据模型 / 数据结构

视频教程​

数据结构​

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

快捷导入​

Apifox 支持“JSON / XML 智能识别/快捷导入”方式，将 JSON / XML 数据自动识别生成数据结构。

注意

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

智能合并​

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

此功能要求 Apifox 版本号 ≥ 2.1.39。

Apifox 私有化部署

快捷导入 SQL 建表语句​

快捷导入支持 SQL 建表语句，并读取数据库字段长度，写入字段属性。

Apifox 私有化部署

此功能要求 Apifox 版本号 ≥ 2.1.39。

编辑数据结构​

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

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

新增或删除字段。

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

数据模型​

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

管理数据模型​

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

引用数据模型​

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

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

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

  1. 当不需要某个字段时，可以直接点击“隐藏字段”按钮。
  1. 当需要对某个字段进行特殊编辑时，可以点击“取消关联”按钮。

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

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

预览请求响应​

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

生成请求代码​

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

编辑源码​

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

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