提高文档编写的效率,试试引用数据结构功能
2019,1,9 使用技巧


在EOLINKER AMS ,您可以将通用的数据结构保存起来,方便在 API 文档中进行重用,并且当数据结构发生改变时,所有引用了该数据结构的 API 文档均会同步发生改变。

1.创建数据结构。进入 数据结构管理页面,点击 创建数据结构 按钮,输入相关信息并点击 保存 按钮即可:

填入信息格式如下:

2.引用数据结构。当我们需要在 API 文档中快速引用某一个数据结构时,我们在相应的参数类型下拉框中可以选择我们已经创建好的数据结构:值得注意的是,数据结构仅可以用于 API 文档中,API 测试以及 API 自动化测试均无法使用数据结构。

在 API 详情页查看自定义数据结构(参数类型),自定义数据结构在列表中会显示蓝色文字,点击之后会弹窗显示数据结构的详情: