首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何在Springfox Swagger提供的Swagger /v2/api-docs中启用CORS headers?

在Springfox Swagger提供的Swagger /v2/api-docs中启用CORS headers,可以通过以下步骤实现:

  1. 首先,需要在Spring Boot应用程序的配置类中添加一个WebMvcConfigurer bean。可以创建一个新的配置类,或者在现有的配置类中添加以下代码:
代码语言:txt
复制
@Configuration
public class SwaggerConfig implements WebMvcConfigurer {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/v2/api-docs")
                .allowedOrigins("*")
                .allowedMethods("GET", "POST", "PUT", "DELETE")
                .allowedHeaders("*")
                .allowCredentials(true)
                .maxAge(3600);
    }
}
  1. 在上述代码中,.addMapping("/v2/api-docs")指定了需要启用CORS headers的Swagger接口路径。如果Swagger的接口路径不是/v2/api-docs,则需要相应地修改。
  2. .allowedOrigins("*")表示允许所有来源的请求访问Swagger接口。如果只允许特定的来源访问,可以将*替换为相应的来源。
  3. .allowedMethods("GET", "POST", "PUT", "DELETE")指定允许的HTTP请求方法。根据实际需求,可以添加或删除其他方法。
  4. .allowedHeaders("*")表示允许所有请求头。如果只允许特定的请求头,可以将*替换为相应的请求头。
  5. .allowCredentials(true)表示允许发送身份验证凭据(如cookies、HTTP认证或客户端SSL证明)的请求访问Swagger接口。如果不需要发送身份验证凭据,可以将true替换为false
  6. .maxAge(3600)指定预检请求的缓存时间(以秒为单位)。可以根据实际需求进行调整。

完成上述步骤后,重新启动应用程序,Swagger /v2/api-docs接口将启用CORS headers,允许跨域访问。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

在微服务项目中引入 knife4j

生产环境屏蔽 目前 Springfox-Swagger 以及 Knife4j 提供资源接口包括如下:如果你要用的话,记得白名单放行 资源 说明 /doc.html Knife4j提供文档访问地址 /...v2/api-docs-ext Knife4j提供增强接口地址,自2.0.6 版本后删除 /swagger-resources Springfox-Swagger提供分组接口 /v2/api-docs...Springfox-Swagger提供分组实例详情接口 /swagger-ui.html Springfox-Swagger提供文档访问地址 /swagger-resources/configuration.../ui Springfox-Swagger提供 /swagger-resources/configuration/security Springfox-Swagger提供 当我们部署系统到生产系统,为了接口安全...白名单 最后,放上一些可能需要放行白名单地址: "/doc.html" "/v2/api-docs-ext" "/swagger-resources" "/v2/api-docs" "/swagger-ui.html

2.2K30

Swagger3.0官方starter诞生,可以扔掉那些野生starter了

Swagger3.0官方starter诞生,可以扔掉那些野生starter了 swagger介绍 对于 Rest API 来说很重要一部分内容就是文档,Swagger 为我们提供了一套通过代码和注解自动生成文档方法...springfox介绍 由于Spring流行,Marty Pitt编写了一个基于Spring组件swagger-springmvc,用于将swagger集成到springmvc来,而springfox...springfox.documentation.swagger-ui.enabled 参数,可以控制ui展示。 从 Swagger 依赖,我们看到了一个比较有意思概念:openAPI。.../**", "/v2/api-docs", "/v3/api-docs", "/webjars/**" }; httpSecurity.cors()....antMatchers(SWAGGER_WHITELIST).permitAll() 背后swagger地址,你访问v2也成,访问v3也成。

1.8K31

重学Spring系列之Swagger2.0和Swagger3.0

Swagger 给我们提供了一个全新维护 API 文档方式,下面我们就来了解一下它优点 代码变,文档变。...:http://localhost/swagger-ui.html ,如下: swagger不仅提供了静态接口文档展示,还提供了执行接口方法测试功能。...除了ASCIIDOC之外,还有MARKDOWN和CONFLUENCE_MARKUP from(new URL("http://localhost:8080/v2/api-docs"):指定了生成静态部署文档源头配置...同时标志着Swagger2成为过去式。 SpringFox是 spring 社区维护一个项目(非官方),帮助使用者将 swagger2 集成到 Spring 。...也是用来在 Spring 帮助开发者生成文档,并可以轻松在spring boot中使用 ---- 整合springdoc-openapi 在pom.xml里面去掉springfox,添加如下openapi

2K10
领券