重用复杂的spring-福克斯swagger注释

Question

我正在使用spring-fox2@apiimplicitparam注释使swagger-ui显示一个包含授权头和请求的框：

@ApiImplicitParams({
        @ApiImplicitParam(
                name="Authorization",
                value="authorization header containing the bearer token",
                paramType = "header"
        )
})
public void someControllerMethod() {
    ...
}

这工作得很好，但我需要为控制器中的每个方法提供这个授权头。复制和粘贴这是代码气味。我可以为此定义某种快捷注释吗？是否有一种不同的方法告诉swagger-ui为授权头创建一个输入字段？

谢谢！

Answer 1

作为另一种解决方案（我不知道上面的选项），我创建了自己的注解，该注解重用ApiImplicitParam，如下所示：

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.GET)
@ApiImplicitParams({
    @ApiImplicitParam(dataType = "string", paramType = "header", name = HttpHeaders.AUTHORIZATION, value = Constants.ApiKey.DESC),
})
public @interface ApiGetMappingV2 {
    /**
     * Alias for {@link RequestMapping#name}.
     */
    @AliasFor(annotation = RequestMapping.class)
    String name() default "";

    /**
     * Alias for {@link RequestMapping#value}.
     */
    @AliasFor(annotation = RequestMapping.class)
    String value() default "";
}

然后我只使用那个注释而不是映射注释：

    @ApiGetMapping("/foo")
    @ApiOperation(value = "List all available foos")
    public List<Foo> all() throws MyCustomApiException {

但是，由于@apiparam使用的目标，这种方法对它不起作用。

Answer 2

解决问题的另一种方法是完全不使用注释。相反，使用docket添加全局操作参数（参见#22）。您可以将标题添加到docket中的所有操作中。

这种方法的缺点可能是，您最终可能会配置多个docket，从而预先选择（请参见#4、#5、#6)将这些参数添加到哪些操作中。