API网关(spring-cloud-starter-gateway)中的SwaggerAPI文档无法工作(出现“WhitelabelErrorPage”错误)。
创始人
2024-09-08 13:30:45
0
  1. 确保已经在依赖中添加了Swagger和Swagger UI的相关依赖:

    compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'
    compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'
    
  2. 在API网关配置类中,添加Swagger资源(静态页面)的路由配置:

    @Bean
    public RouterFunction swaggerRouterFunction() {
        return RouterFunctions.resources("/swagger/**", new ClassPathResource("META-INF/resources/"));
    }
    
  3. 在Swagger配置类中,添加对应的注解,以开启Swagger文档的生成与展示:

    @Configuration
    @EnableSwagger2WebFlux
    public class SwaggerConfiguration {
    
        @Bean
        public Docket api() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("API Documentation")
                    .description("API Documentation")
                    .version("1.0")
                    .build();
        }
    }
    
  4. 在spring-cloud-starter-gateway的配置文件中,添加Swagger UI的路由映射:

    - id: Swagger-UI
      uri: lb://swagger-ui
      predicates:
        - Path=/swagger/**
    

    注意:其中lb://swagger-ui是Swagger UI服务的负载均衡路由名称,例如:

    spring:
      cloud:
        gateway:
          routes:
            - id: swagger-gateway
              uri: http://localhost:8080
              predicates:
                - Path=/api/**
    
            - id: Swagger-UI
              uri: lb://swagger-ui
              predicates:
                - Path=/swagger/**
    
          discovery:
            locator:
              lower-case-service-id: true
    

    其中,"Swagger-UI"是对Swagger UI服务名称的定义,在lb://swagger-ui中的"swagger-ui"即为Swagger UI的服务名,需要在服务注册中心中进行注册。

重启API网关后,访问http://api-gateway:8080/swagger-ui.html,即可成功访问Swagger API文档。

相关内容

热门资讯

一分钟了解(wopoker)外... 一分钟了解(wopoker)外挂透明挂辅助软件(软件透明挂)一般真的有挂(2023已更新)(小红书)...
推荐十款(wepoke)外挂透... 推荐十款(wepoke)外挂透明挂辅助安装(智能ai代打)的确是有挂的(2020已更新)(百度)1、...
科普(WepokE)外挂透明挂... 科普(WepokE)外挂透明挂辅助插件(透视辅助)的确是有挂的(2025已更新)(头条)1、起透看视...
最新研发(wpK)外挂透明挂辅... 最新研发(wpK)外挂透明挂辅助工具(透视)就是真的有挂(2022已更新)(小红书)1、系统规律教程...
重大推荐(云扑克app)外挂透... 重大推荐(云扑克app)外挂透明挂辅助脚本(软件透明挂)总是真的有挂(2020已更新)(百度)辅助器...
必备科技(poker worl... 必备科技(poker world)外挂透明挂辅助器(透视辅助)都是真的有挂(2024已更新)(微博热...
重大推荐(we辅助poker)... 重大推荐(we辅助poker)外挂透明挂辅助脚本(透视辅助)一贯真的有挂(2023已更新)(百度)w...
一分钟了解(来玩德州)外挂透明... 一分钟了解(来玩德州)外挂透明挂辅助插件(透视辅助)原来真的有挂(2025已更新)(微博热搜)1、一...
一分钟了解(轰趴大菠萝)外挂透... 一分钟了解(轰趴大菠萝)外挂透明挂辅助安装(辅助挂)原来真的有挂(2022已更新)(知乎)1、每一步...
玩家必用(AAPOKEr)外挂... 玩家必用(AAPOKEr)外挂透明挂辅助工具(智能ai代打)果然真的有挂(2021已更新)(今日头条...