创建带有虚张声势注释的公共零部件

Question

我正在为我的spring boot项目使用swagger注释。

我想为控制器的每个资源返回一个公共响应代码契约。

在文件中：https://github.com/swagger-api/swagger-core/wiki/annotations#apiresponses-apiresponse他们谈论@ApiResponses，但我不能将注释放在类级别。

以下是我所做的：

@Api(value = "Title",
    description = "What this controller is about"
)
@ApiResponses(value = { 
    @ApiResponse(code = 400, message = "Bad stuff from the client"),
    @ApiResponse(code = 404, message = "Item not found") }
    )
public class FooBarController {

      ...

}

但问题是400-客户端和404-项目未找到中的坏东西从未显示在生成的文档中。

在昂首阔步的官方文件中，我看到了这一部分：https://swagger.io/docs/specification/describing-responses/#reuse

问题：如何创建一种带有java注释的“可重用组件”？

谢啦

Answer 1

根据文档，您可以在摘要级别执行此操作。

.useDefaultResponseMessages(false)
        .globalResponseMessage(RequestMethod.GET,
            newArrayList(new ResponseMessageBuilder()
                .code(400)
                .message("Bad stuff from the client")
                .build()))

https://springfox.github.io/springfox/docs/current/#springfox-springmvc和springboot

更新：

如果您想走注释路线，您可以创建自己的并将其放置在控制器上。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@ApiResponses(value = { 
    @ApiResponse(code = 400, message = "Bad stuff from the client"),
    @ApiResponse(code = 404, message = "Item not found") }
    )
public @interface GlobalApiReponses {
}

那就用它吧。。

@Api(value = "Title",
    description = "What this controller is about"
)
@GlobalApiReponses
public class FooBarController

多种方法的结合可能也是一个不错的选择。

@Target（ElementType.TYPE）意味着您可以在类级别应用它。您可以使用ElementType对方法执行相同的操作。方法