在spring mvc中自定义swagger注解

Question

我很高兴使用 swagger 为前端开发人员生成 API 文档。

但是，如果我有一些方法需要在请求的标头中包含不记名令牌或其他内容。问题出现了，我必须在每个方法上反复复制和粘贴整个注释。它违反了 DRY 原则，当我必须对 Bearer 令牌文档进行一些更改时，这将是一场灾难。

当前

@ApiImplicitParam(name="Authorization",value = "Bearer token",dataType = "string", paramType ="header")
public ResponseEntity<Void> doSth(){};

@ApiImplicitParam(name="Authorization",value = "Bearer token",dataType = "string", paramType ="header")
public ResponseEntity<Void> doSth2(){};

@ApiImplicitParam(name="Authorization",value = "Bearer token",dataType = "string", paramType ="header")
public ResponseEntity<Void> doSth3(){};     

我想要做的是创建一个注释 @ApiOauth2 继承自 @ApiImplicitParam(name="Authorization",value = "Bearer token",dataType = "string", paramType ="header")并且可以swagger识别

@ApiOauth2
public ResponseEntity<Void> doSth(){};

@ApiOauth2
public ResponseEntity<Void> doSth2(){};

@ApiOauth2
public ResponseEntity<Void> doSth3(){};

我搜索了注解不能扩展，我该如何实现这种方法？

Answer 1

试试这个：

 @ApiImplicitParams({
 @ApiImplicitParam(
     name="Authorization",
     value = "Bearer token",
     dataType = "string", 
     paramType ="header")
})
public @interface ApiOauth2 {

}