使用Java的swagger注释显示API请求/响应结构

Question

我是swagger的新手，我正在尝试使用swagger.io Annotations库添加API文档，API的示例输入/输出json。我试过这样的事情：

@other annotations here
public ResponseObj doSomething(@ApiParam(name = "testname", value = 
"test value", required = true, example = "{\"userId\":\"1234\"}" 
@RequestBody RequestObj req) {
    //some code here
}

在输出文档中，我只看到名称，值和必填字段，而不是示例。我甚至试过

examples = @Example(value = { @ExampleProperty(value = "examplepropvaluetest") } 

但也看不到。

帮助任何人？ TIA

Answer 1

Swagger将任何请求/响应显示为模型（表格）和示例值（json）。 请参阅下面的secreenshot。

作为模型

作为示例值（xml / json）

单击模型/示例值以在它们之间切换。

Answer 2

我通过使用spring-restdocs（https://github.com/spring-projects/spring-restdocs）解决了这个问题。基本上，在运行测试时会生成文档。