linux

Swagger在Linux上如何认证授权

小樊
39
2025-05-01 07:49:35
栏目: 智能运维

在Linux系统中使用Swagger实现API权限控制,通常涉及以下几个步骤:

集成Spring Security框架

确保你的Spring Boot项目已正确集成Spring Security。这通常需要在pom.xml文件中添加必要的依赖。

配置Spring Security安全规则

创建一个Spring Security配置类(例如SecurityConfig),继承WebSecurityConfigurerAdapter,并重写configure(HttpSecurity http)方法。在这个方法中,定义访问控制规则,指定哪些URL需要身份验证,哪些不需要,以及采用何种认证机制(例如,Basic Auth, JWT, OAuth 2.0)。

Swagger配置

创建一个Swagger配置类(例如SwaggerConfig),使用@Configuration注解。在这个类中,配置Docket bean,设置API信息、扫描的包路径等。

整合Spring Security与Swagger

为了使Swagger UI也受到Spring Security的保护,需要自定义SecurityScheme并将其添加到Swagger配置中。这通常涉及创建SecuritySchemeSecurityContext bean,并将它们添加到Docket bean的配置中。

以下是一个简化的代码示例,演示如何在Spring Boot应用中集成Spring Security和Swagger,并实现基本的权限控制(使用Basic Auth):

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .antMatchers("/swagger-ui.html", "/webjars/**", "/swagger-resources/**", "/v2/api-docs").authenticated()
            .anyRequest().permitAll()
            .and()
            .httpBasic();
    }
}

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) // 替换成你的controller包路径
            .paths(PathSelectors.any())
            .build()
            .securitySchemes(Arrays.asList(basicAuth()))
            .securityContexts(Arrays.asList(securityContext()));
    }

    private SecurityScheme basicAuth() {
        return new ApiKey("Basic Auth", "Authorization", "header");
    }

    private SecurityContext securityContext() {
        return SecurityContext.builder()
            .securityReferences(defaultAuth())
            .forPaths(PathSelectors.any())
            .build();
    }

    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return Arrays.asList(new SecurityReference("Basic Auth", authorizationScopes));
    }
}

请注意,你需要将"com.example.demo.controller"替换成你实际的控制器包路径。这个示例使用了Basic Auth,你可以根据你的安全需求选择其他的认证机制。

测试权限控制

部署应用后,访问Swagger UI页面,尝试访问受保护的API端点,验证只有经过身份验证的用户才能访问。

0
看了该问题的人还看了