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

Question

我是 swagger 的新手，我正在尝试向 API 文档添加一个使用 swagger.io Annotations 库的 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

标签： javaannotationsswagger

Answer 1

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

作为模型

作为示例值（xml / json）

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