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

相关内容

热门资讯

保存时出现了1个错误,导致这篇... 当保存文章时出现错误时,可以通过以下步骤解决问题:查看错误信息:查看错误提示信息可以帮助我们了解具体...
汇川伺服电机位置控制模式参数配... 1. 基本控制参数设置 1)设置位置控制模式   2)绝对值位置线性模...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
本地主机上的图像未显示 问题描述:在本地主机上显示图像时,图像未能正常显示。解决方法:以下是一些可能的解决方法,具体取决于问...
不一致的条件格式 要解决不一致的条件格式问题,可以按照以下步骤进行:确定条件格式的规则:首先,需要明确条件格式的规则是...
表格中数据未显示 当表格中的数据未显示时,可能是由于以下几个原因导致的:HTML代码问题:检查表格的HTML代码是否正...
表格列调整大小出现问题 问题描述:表格列调整大小出现问题,无法正常调整列宽。解决方法:检查表格的布局方式是否正确。确保表格使...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...