在 springdoc-openapi-ui 中为承载令牌身份验证（JWT）启用授权按钮

Question

如何在springdoc-openapi-ui (OpenAPI 3.0 /swagger-ui.html) 中启用“授权”按钮以进行不记名令牌身份验证，例如 JWT。

Spring @Controller 和 @Configuration 类必须添加哪些注解？

Answer 1

如果您想避免在 @RestController 中使用 security 属性注释每个 @Operation，您可以在类级别添加它，从而影响控制器的每个操作。

请不要忘记您的配置 bean 需要与其他示例中的相同：

@Configuration
@OpenAPIDefinition(info = @Info(title = "My API", version = "v1"))
@SecurityScheme(
    name = "bearerAuth",
    type = SecuritySchemeType.HTTP,
    bearerFormat = "JWT",
    scheme = "bearer"
)
public class OpenApi30Config {
}

在类级别添加安全要求

您只需在那些您想限制 API 调用的类上使用 @SecurityRequirement(name = "bearerAuth")。请注意，这些注释是继承的，因此您也可以将它们添加到任何界面。

创建一个带有所需注解的标记界面：

@SecurityRequirement(name = "bearerAuth")
public interface SecuredRestController {
}

将标记接口添加到您希望将限制应用于所有操作的那些控制器，例如：

@RestController
@RequestMapping("/hello")
public class HelloController implements SecuredController {

    @GetMapping
    public String hello() {
        return "Hello World";
    }

    @GetMapping("/{name}")
    public String helloWithName(@PathVariable String name) {
        return "Hello " + name;
    }

}

你可以在没有标记界面的情况下这样做：

@RestController
@RequestMapping("/hello")
@SecurityRequirement(name = "bearerAuth")
public class HelloController {
...
}

现在您的操作都受到保护并需要 JWT 令牌。

在方法级别添加安全要求

正如在另一篇文章中所说，您必须将@SecurityRequirement 添加到您的方法的@Operation 注释中。

@RestController
@RequestMapping("/hello")
public class HelloController {

    @GetMapping
    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
    public String hello() {
        return "Hello World";
    }

    @GetMapping("/{name}")
    public String helloWithName(@PathVariable String name) {
        return "Hello " + name;
    }

}

这仅限制第一个操作，而不限制第二个操作。

Answer 2

我更喜欢使用 bean 初始化而不是注解。

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info; 
import io.swagger.v3.oas.models.security.SecurityRequirement; 
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.StringUtils;

@Configuration
public class OpenApi30Config {

  private final String moduleName;
  private final String apiVersion;

  public OpenApi30Config(
      @Value("${module-name}") String moduleName,
      @Value("${api-version}") String apiVersion) {
    this.moduleName = moduleName;
    this.apiVersion = apiVersion;
  }

  @Bean
  public OpenAPI customOpenAPI() {
    final String securitySchemeName = "bearerAuth";
    final String apiTitle = String.format("%s API", StringUtils.capitalize(moduleName));
    return new OpenAPI()
        .addSecurityItem(new SecurityRequirement().addList(securitySchemeName))
        .components(
            new Components()
                .addSecuritySchemes(securitySchemeName,
                    new SecurityScheme()
                        .name(securitySchemeName)
                        .type(SecurityScheme.Type.HTTP)
                        .scheme("bearer")
                        .bearerFormat("JWT")
                )
        )
        .info(new Info().title(apiTitle).version(apiVersion));
  }
}

代码行

.addSecurityItem(new SecurityRequirement().addList(securitySchemeName))

允许添加全局安全模式并摆脱对每个 @Operation 的写入安全性 方法。

Answer 3

使用 @Configuration bean 中的注释 @io.swagger.v3.oas.annotations.security.SecurityScheme 为 OpenAPI 3.0 定义全局安全方案：

@Configuration
@OpenAPIDefinition(info = @Info(title = "My API", version = "v1"))
@SecurityScheme(
    name = "bearerAuth",
    type = SecuritySchemeType.HTTP,
    bearerFormat = "JWT",
    scheme = "bearer"
)
public class OpenApi30Config {

}

使用 @io.swagger.v3.oas.annotations.Operation 引用定义的安全方案来注释每个需要承载令牌身份验证 (JWT) 的 @RestController 方法：

@Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))