在 Swagger UI 中添加请求参数

Question

我正在尝试将 swagger UI 2.6.1 集成到我的 Spring Boot 项目中。现在我得到的页面如链接中的图像所示。正如我们所看到的，post 请求没有示例请求参数。我的问题是我应该如何添加这些示例请求，以及要在我的 java 代码或某些属性文件中进行哪些更改？我想知道我需要在何处添加请求参数，以便在我的 swagger 视图中反映出来？

Answer 1

如果请求参数是 Java 8 可选参数，则 swagger docent 在 UI 中显示它们。您必须将“.genericModelSubstitutes(Optional.class)”添加到您的 Docket-Bean 创建中：

public Docket sampleApi() { return new Docket(DocumentationType.SWAGGER_2) .useDefaultResponseMessages(false) .groupName("sample-api") .apiInfo(apiInfo()) .select() .paths(regex("/api.*") )) .build() .genericModelSubstitutes(Optional.class); // 添加这个 }