Apikit 自学日记:数据结构

您可以将API文档中的重复部分提取出来成为数据结构，方便其他文档中复用。当数据结构发生改变时，所有引用了该数据结构的API文档会同步发生改变。

创建数据结构

进入数据结构管理页面，点击 添加数据结构 按钮，输入相关内容并保存即可。

 

在API文档中引入数据结构

进入API编辑页，添加参数时选择 引用现有的数据结构，在弹窗中选择需要引用的数据结构，点击确认即可。

引用的数据结构会在页面中用红色背景标识出来，我们可以在引用的数据结构里再次修改部分的内容（除了参数名）。

 

 

在API文档中将数据结构作为参数类型

您可以在参数类型下拉框中选择数据结构。

 

在API文档详情页中，使用数据结构作为参数类型的字段会显示为蓝色，点击之后会弹窗显示该数据结构的详情。

 

 

修改数据结构

修改数据结构后，所有引用了该数据结构的API均会发生改变。

查看引用

响应的数据结构右边有个查看引用按钮，可以查看引用状况

 

 

删除数据结构

删除数据结构前，系统会检测当前数据结构是否被引用，如果已经被引用则必须先删除引用或者删除API。

进入 数据结构管理 页面，选择进去响应的数据结构，点击数据结构的 删除 按钮即可（如果数据结构被引用，则删除按钮不可用）。