Java swagger注释用于授权

Posted 2021-04-08

我正在使用以下swagger依赖关系为我的休息api：

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-rs-service-description-swagger</artifactId>
    <version>3.2.6</version>
</dependency>
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>swagger-ui</artifactId>
    <version>3.17.6</version>
</dependency>

现在我正在为我的项目添加安全性。如何实现从swagger使用api的可能性？

我可以为每种方法设置@HeaderParam(HttpHeaders.AUTHORIZATION) - 但我想有更好的方法吗？

答案

所以现在我想与您分享我使用的工作解决方案：

@SwaggerDefinition(securityDefinition = @SecurityDefinition(
    apiKeyAuthDefinitions = {
            @ApiKeyAuthDefinition(
                    key = HttpHeaders.AUTHORIZATION,
                    name = HttpHeaders.AUTHORIZATION,
                    in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER
            )
    }
))

它将为您的Swagger UI创建安全按钮以设置auth标头。现在您只需要像这样注释要保护的api：

@Api(value = "Your value", description = "Your description", authorizations = {
    @Authorization(HttpHeaders.AUTHORIZATION)
})

当然你可以使用自定义标题，但对于我的解决方案，我使用了HttpHeaders.AUTHORIZATION。

所以我希望它会对某人有所帮助。