如何在Linux上配置Swagger的权限控制 - 问答

在Linux上配置Swagger的权限控制通常涉及几个步骤，包括设置Spring Security、配置Swagger以及确保安全性。以下是一个基本的指南：

1. 添加依赖

首先，确保你的项目中包含了Spring Security和Swagger的相关依赖。如果你使用的是Maven，可以在pom.xml中添加以下依赖：

<!-- Spring Security -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2. 配置Spring Security

创建一个Spring Security配置类来定义权限控制规则。以下是一个简单的示例：

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.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;

@Configuration
@EnableWebSecurity
public class WebSecurityConfig 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()
            .formLogin()
            .and()
            .httpBasic();
    }

    @Bean
    @Override
    public UserDetailsService userDetailsService() {
        UserDetails user =
             User.withDefaultPasswordEncoder()
                .username("user")
                .password("password")
                .roles("USER")
                .build();

        return new InMemoryUserDetailsManager(user);
    }
}

在这个配置中，我们定义了哪些URL需要认证，哪些不需要。例如，Swagger UI和API文档页面需要认证。

3. 配置Swagger

创建一个Swagger配置类来启用Swagger并配置API文档：

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"))
                .paths(PathSelectors.any())
                .build();
    }
}

4. 运行应用程序

确保你的Spring Boot应用程序已经配置好并运行在Linux服务器上。你可以使用以下命令来启动应用程序：

java -jar your-application.jar

5. 访问Swagger UI

打开浏览器并访问http://your-server-address:port/swagger-ui.html。你应该会看到Swagger UI界面，并且需要输入用户名和密码才能访问。

总结

通过以上步骤，你可以在Linux上配置Swagger的权限控制。确保你的Spring Security配置正确，并且Swagger UI和API文档页面受到保护。这样，只有经过认证的用户才能访问这些资源。

0 赞

0 踩