数据结构
功能简介
Apifox 中的“数据结构”功能和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和 json / xml 类型的“Body 参数”。
![](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-1-a9736f1b0570c2097b6862e8d2e8e34e.png)
快捷导入
Apifox 支持“JSON / XML 智能识别/快捷导入”方式,将 JSON / XML 数据自动识别生成数据结构。
![](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-2-84b18f92214a9b6d90e6b90a24b454b2.png)
注意
JSON 智能识别的作用只是生成数据结构,并不会将 JSON 里的值保存下来。Apifox 在 2.1.39 版本之后,JSON 智能识别功能支持识别“注释”字段,并写入说明。
![](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-3-d75f535ea8503a597169dc31b2f95e6e.png)
智能合并
当字段已经存在 mock、中文名、说明时,使用智能合并
。导入相同字段,新导入的部分不会覆盖原有的 mock、中文名、说明。
此功能要求 Apifox 版本号 ≥ 2.1.39。
![Apifox 私有化部署](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-3-1-571355906d3d1bef91b2f18ae2f96af7.png)
快捷导入 SQL 建表语句
快捷导入支持 SQL 建表语句,并读取数据库字段长度,写入字段属性。
![Apifox 私有化部署](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-3-2-5a14f7d9a06826157fbbedc8b65b7747.png)
此功能要求 Apifox 版本号 ≥ 2.1.39。
编辑数据结构
选择该数据字段是否为必填项。
![](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-4-934e83128df28fe25169f8ee542a103f.png)
调整选择字段的数据类型。同时你还可以编辑该字段的“Mock 设置”,详细语法说明请阅读《Mock 语法》。
![](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-5-fe3fd04bf483dc3be295c71597f43a89.png)
新增或删除字段。
![](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-6-3551e202dd3930c6bd25787473a892ae.png)
拖拽移动并改变字段之间的排序。
![](https://cdn.apifox.com/mirror-www/help/assets/images/api-schema-7-2d06103422fe5f00ae950ec32348979c.png)