跳到主要内容

保存为响应示例

如何添加一个响应示例？​

响应示例是一篇接口文档中不可缺少的内容，能够快速向使用接口的人传到接口的响应数据。

你可以通过两种方式来编写你的接口响应示例：

如果你是CodeFirst​

您已经写好了接口代码，只需要调试接口并生成文档。

在调试tab下进行接口调试时，可以在响应区使用一键保存响应的功能，这样在调试后能够快速将接口返回的响应存为响应示例，并呈现在文档中。

  • 1、发送接口，在响应查看响应
  • 2、点击保存按钮，选择将当前的响应内容保存为成功示例或失败示例，你也可以选择新建一个示例来存储当前的响应内容
  • 3、最后，点击保存按钮以保存接口，或使用快捷键Ctrl+S（Command+S）进行保存。

image.png

image.png

image.png

如果你是APIFirst​

您需要先设计接口的请求参数和响应参数，并生成文档。

在设计tab下可以设计接口的响应期望示例，并保存，就可以在文档中呈现了。

  • 点击【新建期望】：填写期望名称，状态码，格式
  • 设计数据结构：其中JSON/XML格式支持设计Schema结构。
  • 填写响应示例值：最后点击保存按钮以保存接口，或使用快捷键Ctrl+S（Command+S）进行保存。

image.png

image.png

image.png