您能够将 API 文档中的重复部分提取进去成为数据结构,不便其余文档中复用。当数据结构产生扭转时,所有援用了该数据结构的 API 文档会同步产生扭转。
创立数据结构
进入数据结构治理页面,点击 增加数据结构 按钮,输出相干内容并保留即可。
在 API 文档中引入数据结构
进入 API 编辑页,增加参数时抉择 援用现有的数据结构,在弹窗中抉择须要援用的数据结构,点击确认即可。
援用的数据结构会在页面中用红色背景标识进去,咱们能够在援用的数据结构里再次批改局部的内容(除了参数名)。
在 API 文档中将数据结构作为参数类型
您能够在参数类型下拉框中抉择数据结构。
在 API 文档详情页中,应用数据结构作为参数类型的字段会显示为蓝色,点击之后会弹窗显示该数据结构的详情。
批改数据结构
批改数据结构后,所有援用了该数据结构的 API 均会产生扭转。
查看援用
响应的数据结构左边有个查看援用按钮,能够查看援用情况
删除数据
构造删除数据结构前,零碎会检测以后数据结构是否被援用,如果曾经被援用则必须先删除援用或者删除 API。
进入 数据结构治理 页面,抉择进去响应的数据结构,点击数据结构的 删除 按钮即可(如果数据结构被援用,则删除按钮不可用)。