数据结构
简介
您可以将通用的数据结构保存起来,方便在API文档中进行重用,并且当数据结构发生改变时,所有引用了该数据结构的API文档均会同步发生改变。
创建数据结构
进入 数据结构管理 页面,点击 创建数据结构 按钮,输入相关信息并点击 保存 按钮即可:
修改数据结构
修改数据结构后,所有引用了该数据结构的API均会发生改变,因此数据结构可以复用并减少编写API文档的工作量。
进入 数据结构管理 页面,点击相应数据结构的 修改 按钮即可:
删除数据结构
删除数据结构前,系统会检测当前数据结构是否被API引用,如果数据结构被API引用,则必须先删除引用或者删除API,否则无法删除数据结构。
进入 数据结构管理 页面,点击数据结构的 删除 按钮即可:
将数据结构作为参数类型在API中引用
数据结构仅可以用于API文档中,API测试以及API自动化测试均无法使用数据结构。
当我们需要在API文档中快速引用某一个数据结构时,我们在相应的参数类型下拉框中可以选择我们已经创建好的数据结构:
在API详情页查看自定义数据结构(参数类型)
自定义数据结构在列表中会显示蓝色文字,点击之后会弹窗显示数据结构的详情: