Linux环境下Swagger如何处理跨域请求 - 问答

在Linux环境下，处理Swagger跨域请求通常涉及到配置CORS（跨来源资源共享）。以下是一些常见的方法来处理Swagger中的跨域请求：

方法一：使用Spring Boot和Springfox Swagger

如果你使用的是Spring Boot和Springfox Swagger，可以通过配置CorsConfiguration来处理跨域请求。

添加依赖：确保你的pom.xml或build.gradle文件中包含Springfox Swagger的依赖。

<!-- pom.xml -->
<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>

配置CORS：创建一个配置类来设置CORS。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
                .allowedHeaders("*")
                .allowCredentials(true);
    }
}

配置Swagger：确保你的Swagger配置类也应用了CORS配置。

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();
    }
}

方法二：使用Spring Boot和Spring WebFlux

如果你使用的是Spring Boot和Spring WebFlux，可以通过配置CorsWebFilter来处理跨域请求。

添加依赖：确保你的pom.xml或build.gradle文件中包含Spring WebFlux的依赖。

<!-- pom.xml -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
<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>

配置CORS：创建一个配置类来设置CORS。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.reactive.CorsWebFilter;
import org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource;

@Configuration
public class WebConfig {

    @Bean
    public CorsWebFilter corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        CorsConfiguration config = new CorsConfiguration();
        config.setAllowCredentials(true);
        config.addAllowedOrigin("*");
        config.addAllowedHeader("*");
        config.addAllowedMethod("*");
        source.registerCorsConfiguration("/**", config);
        return new CorsWebFilter(source);
    }
}

配置Swagger：确保你的Swagger配置类也应用了CORS配置。

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();
    }
}

方法三：使用Nginx反向代理

如果你使用Nginx作为反向代理服务器，可以在Nginx配置文件中添加CORS相关的配置。

编辑Nginx配置文件：打开你的Nginx配置文件（通常位于/etc/nginx/nginx.conf或/etc/nginx/sites-available/default）。

添加CORS配置：在server块中添加以下配置。

server {
    listen 80;
    server_name yourdomain.com;

    location /swagger-ui.html {
        add_header 'Access-Control-Allow-Origin' '*';
        add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
        add_header 'Access-Control-Allow-Headers' 'Origin, X-Requested-With, Content-Type, Accept';
        proxy_pass http://localhost:8080;
    }

    location /v2/api-docs {
        add_header 'Access-Control-Allow-Origin' '*';
        add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
        add_header 'Access-Control-Allow-Headers' 'Origin, X-Requested-With, Content-Type, Accept';
        proxy_pass http://localhost:8080;
    }

    location /webjars/ {
        proxy_pass http://localhost:8080/webjars/;
    }

    location /swagger-resources/ {
        proxy_pass http://localhost:8080/swagger-resources/;
    }
}

重启Nginx：保存配置文件并重启Nginx。
```
sudo systemctl restart nginx
```

通过以上方法，你可以在Linux环境下处理Swagger的跨域请求。选择适合你项目的方法进行配置即可。

0 赞

0 踩