在swagger UI中生成示例示例（在Spring boot项目中）

Question

我正在使用一个Spring Boot应用程序，并使用Swagger UI进行配置。

我想知道我们是否可以用示例值预先填充示例值，这样我们就可以点击“try it out！”按钮，而不必输入一些示例值以获得响应。

我正在使用一个带有springfox-swagger2:2.7.0和springfox-swagger-ui:2.7.0的Spring Boot项目，并使用Gradle添加了依赖项。

Answer 1

由于@apiparam属性example和example不起作用（请参阅GitHub上的这个问题），所以对添加示例的支持有限/不存在。

对于简单参数(@requestparam)可以做的是添加带有defaultvalue属性的@apiparam批注，如下所示：

@GetMapping
public List<Foo> findAll(
        @RequestParam(required = false)
        @ApiParam(defaultValue = "foo") // Put the default value here
        String input) {
    // ...
}

但是，目前还不支持使用@requestbody参数执行此操作。

对于@requestbody参数，一个可能的解决方法是单击Swagger tester右侧的code框，其中显示示例值。如果您单击它，它会将该示例插入字段本身。