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文档。

相关内容

热门资讯

2026外挂!雀友会广东潮汕麻... 2026外挂!雀友会广东潮汕麻将辅助软件,芒果辅助器(好像是有挂)1、用户打开应用后不用登录就可以直...
2026外挂!哈糖大菠萝辅助,... 2026外挂!哈糖大菠萝辅助,奇迹手游辅助脚本平台免费(一直真的有挂)1、奇迹手游辅助脚本平台免费脚...
2026外挂!辅助定制交易平台... 2026外挂!辅助定制交易平台,情怀破解(本来有挂)1、起透看视 辅助定制交易平台辅助软件价格2、随...
2026外挂!九酷众游软件,5... 2026外挂!九酷众游软件,510k中至余干辅助(原来真的是有挂)1、玩家可以在510k中至余干辅助...
2026外挂!极速官方游戏暗堡... 2026外挂!极速官方游戏暗堡辅助器,楚天游辅助(其实存在有挂)1、上手简单,内置详细流程视频教学,...
2026外挂!免费游戏辅助软件... 2026外挂!免费游戏辅助软件,如何设置钱塘十三水辅助器(切实是真的有挂)1、2026外挂!免费游戏...
2026外挂!雀姬辅助脚本,微... 2026外挂!雀姬辅助脚本,微乐游戏辅助脚本安装(切实有挂)2026外挂!雀姬辅助脚本,微乐游戏辅助...
2026外挂!飞驰娱乐软件科技... 2026外挂!飞驰娱乐软件科技,科乐填大坑辅助器(切实真的有挂)1、科乐填大坑辅助器免费辅助多个强度...
2026外挂!皮皮胡子辅助,天... 2026外挂!皮皮胡子辅助,天天贵阳破解版(原来是真的有挂)天天贵阳破解版是不是有人用挂微扑克wpk...
2026外挂!科技实测欢乐辅助... 2026外挂!科技实测欢乐辅助,丽水都莱辅助软件(都是是有挂)小薇(辅助器软件下载)致您一封信;亲爱...