响应参数的描述填写

提示

如果您习惯先进行API设计，可直接查看如何在API设计中填写参数描述
如果您习惯直接进行API调试，可直接查看如何在API调试中填写参数描述

在API设计中如何填写

在预定义响应期望中，可以对json-schema的数据结构直接填写字段描述，如下：

在文档中的展示如下：

在API调试中如何填写

因为Apipost不会把发送后的实时响应的数据作为响应示例，需要手动的将实时响应结果导入或者复制到对应的成功响应示例和错误响应示例。

字段描述的填写跟raw类型的body参数，我们可以通过点击“提取字段和描述”来针对参数进行描述的填写。

在文档中的展示如下：

同样，对于已经填写过的参数，Apipost会自动匹配描述，不用重复填写。