API网关(spring-cloud-starter-gateway)中的SwaggerAPI文档无法工作(出现“WhitelabelErrorPage”错误)。
创始人
2024-09-08 13:30:47
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文档。

相关内容

热门资讯

安卓系统怎么连不上carlif... 安卓系统无法连接CarLife的原因及解决方法随着智能手机的普及,CarLife这一车载互联功能为驾...
iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
oppo手机安卓系统换成苹果系... OPPO手机安卓系统换成苹果系统:现实吗?如何操作?随着智能手机市场的不断发展,用户对于手机系统的需...
安卓平板改windows 系统... 你有没有想过,你的安卓平板电脑是不是也能变身成Windows系统的超级英雄呢?想象在同一个设备上,你...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...
安卓系统上滑按键,便捷生活与高... 你有没有发现,现在手机屏幕越来越大,操作起来却越来越方便了呢?这都得归功于安卓系统上的那些神奇的上滑...
安卓系统连接耳机模式,蓝牙、有... 亲爱的手机控们,你们有没有遇到过这种情况:手机突然变成了“耳机模式”,明明耳机没插,声音却只从耳机孔...
希沃系统怎么装安卓系统,解锁更... 亲爱的读者们,你是否也像我一样,对希沃一体机上的安卓系统充满了好奇呢?想象在教室里,你的希沃一体机不...
安装了Anaconda之后找不... 在安装Anaconda后,如果找不到Jupyter Notebook,可以尝试以下解决方法:检查环境...
安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...