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

相关内容

热门资讯

安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...
app安卓系统登录不了,解锁登... 最近是不是你也遇到了这样的烦恼:手机里那个心爱的APP,突然就登录不上了?别急,让我来帮你一步步排查...
安卓系统拦截短信在哪,安卓系统... 你是不是也遇到了这种情况:手机里突然冒出了很多垃圾短信,烦不胜烦?别急,今天就来教你怎么在安卓系统里...
安卓系统要维护多久,安卓系统维... 你有没有想过,你的安卓手机里那个陪伴你度过了无数日夜的安卓系统,它究竟要陪伴你多久呢?这个问题,估计...
windows官网系统多少钱 Windows官网系统价格一览:了解正版Windows的购买成本Windows 11官方价格解析微软...
安卓系统如何卸载app,轻松掌... 手机里的App越来越多,是不是感觉内存不够用了?别急,今天就来教你怎么轻松卸载安卓系统里的App,让...
怎么复制照片安卓系统,操作步骤... 亲爱的手机控们,是不是有时候想把自己的手机照片分享给朋友,或者备份到电脑上呢?别急,今天就来教你怎么...
安卓系统应用怎么重装,安卓应用... 手机里的安卓应用突然罢工了,是不是让你头疼不已?别急,今天就来手把手教你如何重装安卓系统应用,让你的...
iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...