Apifox如何使用数据结构 / 数据模型

2025-04-06 05:50:44

剞麽苍足数据结构

数据结构和编程语言里的数据结构类似,主要使用在接口设计的返回响应和 json / xml 类型的Body 参数。

Apifox如何使用数据结构 / 数据模型

JSON 智能识别/快捷导入

通过 JSON 数据自动识别生成数据结构,如果你已经有 JSON 数据了,这是一个快捷生成的方式。

注意

JSON 智能识别的作用只是生成数据结构,并不会将 JSON 里的值保存下来。

Apifox如何使用数据结构 / 数据模型
Apifox如何使用数据结构 / 数据模型

编辑数据结构

1.可以选择该字段是否必填

Apifox如何使用数据结构 / 数据模型

2.可以选择该字段的数据类型

Apifox如何使用数据结构 / 数据模型

3.可以编辑该字段的Mock 设置,具体语法可以查看 Mock 语法

4.可以新增字段,或删除该字段

Apifox如何使用数据结构 / 数据模型

5.可拖拽移动,改变字段之间的排序

Apifox如何使用数据结构 / 数据模型

数据模型

数据模型是可复用的数据结构。在设计数据结构时可以在数据类型直接选择已经定义好的数据模型。

管理数据模型

在使用数据模型前,需要先建立可复用的数据结构。如下图,根据项目需要,可以先在数据模型下新建,也可以简单的管理不同数据模型间的关系。

Apifox如何使用数据结构 / 数据模型

数据模型的引用

接口设计的返回响应和 json / xml 类型的Body 参数处,在数据类型处可以引用已经建立好的数据模型,如下图。

Apifox如何使用数据结构 / 数据模型

1.当前引用的数据模型不符合要求,需要修改时,可以直接跳转到数据模型进行修改

Apifox如何使用数据结构 / 数据模型

2.当下接口需要部分引用数据模型时,可以在引用的情况下修改,并且不影响原数据模型

①当不需要数据模型中的某个字段时,可以点击隐藏字段,则接口文档中就不会显示了

Apifox如何使用数据结构 / 数据模型

②当需要对数据模型中的某个字段,特殊编辑时,可以点击取消关联。当然后续也可以恢复关联

Apifox如何使用数据结构 / 数据模型
Apifox如何使用数据结构 / 数据模型

3.可以引用多个数据模型,并支持数据模型之间拖拽排序

Apifox如何使用数据结构 / 数据模型
Apifox如何使用数据结构 / 数据模型

声明:本网站引用、摘录或转载内容仅供网站访问者交流或参考,不代表本站立场,如存在版权或非法内容,请联系站长删除,联系邮箱:site.kefu@qq.com。
猜你喜欢