在Linux环境下,使用Swagger实现接口权限控制通常涉及以下几个步骤:
集成Spring Security:
pom.xml
中添加Spring Security依赖:<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
配置Spring Security:
SecurityConfig.java
:import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
http
.csrf().disable()
.authorizeRequests()
.antMatchers("/swagger-ui/**", "/v2/api-docs/**").authenticated() // 需要认证的URL
.anyRequest().permitAll() // 其他请求允许访问
.and()
.httpBasic(); // 使用HTTP Basic认证
}
@Bean
public PasswordEncoder passwordEncoder() {
return new BCryptPasswordEncoder();
}
}
配置Swagger:
SwaggerConfig.java
:import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build();
}
}
测试权限控制:
http://localhost:8080/swagger-ui.html
)。/swagger-ui/**
或/v2/api-docs/**
,系统会提示你输入用户名和密码。通过以上步骤,你可以在Linux环境下使用Swagger实现接口权限控制。Spring Security提供了强大的认证和授权功能,可以轻松地与Swagger集成,确保只有经过认证的用户才能访问受保护的API。