在Java EE/Jersey中为生成的Swagger UI添加承载令牌字段

Question

我有一个Java EE8应用程序，在该应用程序中，我使用OpenAPI注释来定义RESTendpoint，并自动生成一个昂首阔步的UI。对于身份验证，我使用JSON Web令牌(JWT)。

当我从邮递员发送请求时，一切都很好，但是，我不知道如何在我的昂首阔步的UI中添加一个承载令牌的字段。

我使用@securityscheme注释定义我的安全方案：

@SecurityScheme(
        securitySchemeName = "JWT",
        description = "JWT authentication with bearer token",
        type = SecuritySchemeType.HTTP,
        scheme = "bearer",
        bearerFormat = "Bearer [token]"
)
public class ApplicationConfig extends Application {

}

我尝试将此方案作为@securityrequirement添加到资源的@openapidefinition注释中，并直接添加到方法中。

@Path("/items")
@OpenAPIDefinition(
        info = @Info(title = "Items resource", version = "v1"),
        security = @SecurityRequirement(name = "JWT")
)
@Transactional(value = TxType.REQUIRES_NEW)
@Interceptors({RolesAllowedInterceptor.class})
@SecurityScheme(
        securitySchemeName = "JWT",
        description = "JWT authentication with bearer token",
        type = SecuritySchemeType.HTTP,
        scheme = "bearer",
        bearerFormat = "Bearer [token]"
)
public class ItemsResource {

    (...)

    @GET
    @Operation(description = "Returns the item list overview")
    @APIResponse(responseCode = "200", description = "Valid response")
    @APIResponse(responseCode = "401", description = "Authentication required")
    @APIResponse(responseCode = "500", description = "Unexpected exception")
    @Produces({MediaType.APPLICATION_JSON})
    @SecurityRequirement(name ="JWT", scopes = "write: read")
    @RolesAllowed({Constants.USER_ROLE_EXPERT})
    public Response getItemListOverview() throws TechnicalException {
        ItemListOverviewVO itemListOverviewVO = logic.getItemListOverview();
        return Response.status(Status.OK).entity(itemListOverviewVO).build();
    }

因此，我现在在OpenAPI JSON文件中有security信息，但是UI中仍然没有用于授权参数的字段。

public Response getItemListOverview(@HeaderParam("Authorization") String bearerToken) throws TechnicalException {

现在我的UI中有一个授权字段，但是当我测试endpoint时，请求没有授权头。我在浏览器的网络分析中看不到它。

到目前为止，OpenAPI文档没有什么帮助。我是不是漏掉了什么？

Answer 1

关键是在@components()中嵌入@securityscheme注释，并将其作为参数传递给@openapidefinition注释：

@OpenAPIDefinition(
        info = @Info(title = "My application", version = "1.0.0"),
        servers = {@Server(url = "/myapp", description = "localhost") },
        security = @SecurityRequirement(name = "JWT"),
        components = @Components(securitySchemes = @SecurityScheme(
                securitySchemeName = "JWT",
                description = "JWT authentication with bearer token",
                type = SecuritySchemeType.HTTP,
                scheme = "bearer",
                bearerFormat = "Bearer [token]"))
)
public class ApplicationConfig extends Application {

}