java - Springfox:@ApiResponse 中的 @ResponseHeader 不会在 Swagger UI 中呈现

Question

我在代码中有Springfox注释如下:

    @ApiResponses(value = {
        @ApiResponse(code = 200, message = "Options for the endpoint", responseHeaders = {@ResponseHeader(name = "Allow", description = "Verbs allowed")})})

但是，在 Swagger UI 中， header 不会呈现在响应下方。

如果我通过 Docket 添加全局响应(针对内部服务器错误)，它的 header 会呈现得很好。

这是配置错误还是这里出了问题？

Answer 1

我的问题是注释参数“response”未设置为 String.class。它默认为 Void.class 并且不使用它进行渲染。

更正后的代码是:

@ApiResponse(code = 200, message = "Options for the endpoint", responseHeaders = {@ResponseHeader(name = "Allow", description = "Verbs allowed", response = String.class)})})