gateway网关聚合swagger实现多个服务之间切换

最新推荐文章于 2024-07-12 10:20:27 发布
最新推荐文章于 2024-07-12 10:20:27 发布
阅读量1.4k 收藏 9
点赞数 3
分类专栏： java swagger 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Handsome____boy/article/details/119924436
版权

效果预览
在这里插入图片描述

项目结构
在这里插入图片描述
springcloud的父依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>swagger-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    
    <modules>
        <module>api-getway</module>
        <module>order</module>
        <module>pay</module>
    </modules>
    
    <packaging>pom</packaging>
    
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>



    <properties>
        <java.version>1.8</java.version>
        <velocity.version>2.0</velocity.version>
        <swagger.version>2.7.0</swagger.version>
        <jodatime.version>2.10.1</jodatime.version>
        <poi.version>3.17</poi.version>
        <commons-fileupload.version>1.3.1</commons-fileupload.version>
        <commons-io.version>2.6</commons-io.version>
        <httpclient.version>4.5.1</httpclient.version>
        <fastjson.version>1.2.28</fastjson.version>
        <gson.version>2.8.2</gson.version>
        <json.version>20170516</json.version>
        <commons-dbutils.version>1.7</commons-dbutils.version>
        <canal.client.version>1.1.0</canal.client.version>
        <docker.image.prefix>zx</docker.image.prefix>
        <cloud-alibaba.version>0.2.2.RELEASE</cloud-alibaba.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!--Spring Cloud-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <!--swagger-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>${swagger.version}</version>
            </dependency>
            <!--swagger ui-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>${swagger.version}</version>
            </dependency>

            <!--httpclient-->
            <dependency>
                <groupId>org.apache.httpcomponents</groupId>
                <artifactId>httpclient</artifactId>
                <version>${httpclient.version}</version>
            </dependency>

            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>${gson.version}</version>
            </dependency>

            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>${fastjson.version}</version>
            </dependency>
            
            <dependency>
                <groupId>org.json</groupId>
                <artifactId>json</artifactId>
                <version>${json.version}</version>
            </dependency>
            
        </dependencies>

    </dependencyManagement>

</project>

getway服务
pom依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>swagger-demo</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>api-getway</artifactId>


    <dependencies>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>0.2.1.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
            <!-- 排除原生的UI -->
            <exclusions>
                <exclusion>
                    <groupId>io.springfox</groupId>
                    <artifactId>springfox-swagger-ui</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        
        <!-- swagger的UI页面-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

    </dependencies>
</project>

yml配置-----注册到nacos中：

server:
  port: 8222

spring:
  application:
    name: service-gateway

  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848

    gateway:
      discovery:
        locator:
          enabled: true
      routes:
        - id: order # 路由的id,没有规定规则但要求唯一,建议配合服务名
          #匹配后提供服务的路由地址
          uri: lb://order
          predicates:
            - Path=/order/** # 断言，路径相匹配的进行路由
          filters:
            - StripPrefix=1


        - id: pay
          uri: lb://pay
          predicates:
            - Path=/pay/** #断言,路径相匹配的进行路由
          filters:
            - StripPrefix=1

三个配置类：

package com.jy.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger.web.SecurityConfiguration;
import springfox.documentation.swagger.web.SecurityConfigurationBuilder;
import springfox.documentation.swagger.web.UiConfiguration;
import springfox.documentation.swagger.web.UiConfigurationBuilder;


@Configuration
public class SwaggerConfig {

    @Bean
    public SecurityConfiguration securityConfiguration() {
        return SecurityConfigurationBuilder.builder().build();
    }

    @Bean
    public UiConfiguration uiConfiguration() {
        return UiConfigurationBuilder.builder().build();
    }

}


package com.jy.swagger;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Mono;
import springfox.documentation.swagger.web.*;

import java.util.List;
import java.util.Optional;


@RestController
@RequestMapping("/swagger-resources")
public class SwaggerHandler {

    private final SecurityConfiguration securityConfiguration;
    private final UiConfiguration uiConfiguration;
    private final SwaggerResourcesProvider swaggerResources;

    @Autowired
    public SwaggerHandler(SwaggerResourcesProvider swaggerResources, SecurityConfiguration securityConfiguration, UiConfiguration uiConfiguration) {
        this.swaggerResources = swaggerResources;
        this.securityConfiguration = securityConfiguration;
        this.uiConfiguration = uiConfiguration;
    }

    @GetMapping("/configuration/security")
    public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
        return Mono.just(new ResponseEntity<>(
                Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()),
                HttpStatus.OK));
    }

    @GetMapping("/configuration/ui")
    public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
        return Mono.just(new ResponseEntity<>(
                Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
    }

    @GetMapping
    public Mono<ResponseEntity<List<SwaggerResource>>> swaggerResources() {
        return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
    }

}



package com.jy.swagger;

import lombok.AllArgsConstructor;
import org.springframework.cloud.gateway.config.GatewayProperties;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.support.NameUtils;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;

import java.util.ArrayList;
import java.util.List;


@Primary
@Component
@AllArgsConstructor
public class SwaggerProvider implements SwaggerResourcesProvider {

    public static final String API_URI = "/v2/api-docs";
    private final RouteLocator routeLocator;
    private final GatewayProperties gatewayProperties;

    @Override
    public List<SwaggerResource> get() {
        List<SwaggerResource> resources = new ArrayList<>();
        List<String> routes = new ArrayList<>();
        routeLocator.getRoutes().subscribe(route -> routes.add(route.getId()));
        gatewayProperties.getRoutes().stream()
                .filter(routeDefinition -> routes.contains(routeDefinition.getId()))
                .forEach(routeDefinition -> routeDefinition.getPredicates().stream()
                        .filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName()))
                        .forEach(predicateDefinition -> resources
                                .add(swaggerResource(routeDefinition.getId(), predicateDefinition.getArgs()
                                        .get(NameUtils.GENERATED_NAME_PREFIX + "0").replace("/**", API_URI)))));
        return resources;
    }

    private SwaggerResource swaggerResource(String name, String url) {
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(name);
        swaggerResource.setUrl(url);
        swaggerResource.setSwaggerVersion("2.0");
        return swaggerResource;
    }
}

启动类：

package com.jy;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;


@SpringBootApplication
@EnableDiscoveryClient
public class ApiGatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(ApiGatewayApplication.class,args);
    }
}

订单order服务
pom依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>swagger-demo</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>order</artifactId>

    <dependencies>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>0.2.1.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
            <!-- 排除原生的UI -->
            <exclusions>
                <exclusion>
                    <groupId>io.springfox</groupId>
                    <artifactId>springfox-swagger-ui</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!-- swagger的UI页面-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>


        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>


        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.60</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>


    </dependencies>

</project>

yml配置：

server:
  port: 6789

spring:
  application:
    name: order

  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848

swagger配置：

package com.jy.config;

import io.swagger.annotations.Api;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@ComponentScan(basePackages = "com.jy.controller")//-----配置自己的路径，因为有时扫描不到接口，需要加此注解
public class SwaggerConfig {

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("测试")
                .description("测试swagger")
                .version("1.0")
                .contact(new Contact("yqy", "http://baidu.com", "8@qq.com"))
                .licenseUrl("127.0.0.1")
                .build();
    }

}

启动类：

package com.jy;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@EnableDiscoveryClient
@ComponentScan(basePackages = {"com.jy.config"})
public class Order {

    public static void main(String[] args) {
        SpringApplication.run(Order.class,args);
    }
}

自己随便在controller包下写接口

支付pay服务

pom复制上面order服务中的，swagger配置复制上面order服务中的，启动类也一样

yml配置：

server:
  port: 5678

spring:
  application:
    name: pay

  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848

访问地址：http://IP:网关端口号/doc.html
例：localhost:8222/doc.html

杨小小！
关注
专栏目录
网关集成多个微服务swgger文档
myBackAtOne的博客
07-06 310
网关集成多个微服务swgger文档
spring-gateway网关聚合swagger实现多个服务接口切换
a14654的博客
03-03 1766
前提条件 微服务已经集成了swagger，并且注册进了nacos。 gateway配置 package com.zmy.springcloud.config; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.cloud.gateway.route.RouteL
SpringCloud Gateway网关统一聚合Swagger接口文档（knife4j），实现通过网关统一文档地址查看所有子服务的接口文档
NameLoadingFailed的博客
03-22 3212
前言： 在微服务系统中，通常每个服务都会暴露其接口文档，在前端人员或测试人员查看的时候，并不是那么方便，我们需要告诉相关人员每个服务的文档地址，由于knif4j官方（更易用的swagger封装，点此了解knif4j）支持以Rest的方式获取所有微服务的文档数据，再配合Gateway的路由，我们可以轻松的通过其相关API做到聚合文档的效果，做到只提供一个文档地址，便可查看所有微服务下的接口文档 注意： 各微服务的knife4j配置及文档访问，观阅此文前默认认为你已经是完成且可访问的，如未完成或遇到问题，参
Gateway 聚合swagger文档
最新发布
booleandev
07-12 401
‍在微服务架构下，通常每个微服务 都会使用 Swagger 来管理我们的接口文档，当微服务越来越多，接口查找管理无形中要浪费我们不少时间，因此，我们需要把其它系统的 Swagger 文档聚合到 Gateway ,方便我们统一查看接口文档。
Gateway配置多个微服务无法正确路由及微服务跨域前端请求无法正确的获取目标路由的响应
neaneanea的博客
05-11 2253
Gateway配置多个微服务无法正确路由及微服务跨域前端请求无法正确的获取目标路由的响应 1.路由无法匹配到解决 之前开发过程当中发现，在室友gateway的时候，多个微服务之间无法正确路由到正确的地方。 然后发现路由多个微服务时，需要配置内加上一定的前缀以加区分，不然无法转发到目标服务 示例配置如下 - id: im-router uri: lb://im-provider1 # 服务名 下划线无法解析_ predicates: - P
Gateway整合Swagger3
qq_34667621的博客
10-11 655
enabled: true # false关闭swagger-ui界面 但不关闭openapi。//结合配置的route-路径(Path)，和route过滤，只获取有效的route节点。* SwaggerResource设置子服务的name、location、version。.description("更多请咨询服务开发者")//描述。.version("1.0")//版本。.title("接口文档")//标题。//取出gateway的route。（2）SwaggerConfig 配置类。
springcloud gateway聚合swagger2的方法示例
08-26
本文主要介绍了 Spring Cloud Gateway 聚合 Swagger2 的方法示例，旨在解决分布式应用中，每个应用通过 Nacos 在网关处装配了路由，希望网关可以将所有应用的 Swagger 界面聚合起来，使前端开发时只需要访问网关的 ...
在网关gateway聚合swagger文档
u014019974的专栏
07-28 816
jar包支持 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>3.0.0</version> </dependency> <depen
微服务gateway聚合swagger文档解决
你一个人,就不想到别处看看? ---- 我怕一转身连你也不见了......
04-28 1119
gateway网关聚合swagger2文档,由于gateway网关需要排除spring-web依赖,使用的是webFlux,故需要对swagger做一些配置 如下在对应的地方排除web依赖: <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <a.
SpringCloud网关（Zuul/Gateway）聚合swagger2文档的一个坑
chenpuma的博客
08-11 1739
最近在新搞公司后台的架构，准备用网关来聚合接口文档（swagger2生成），从注册中心自动获取生成。 按照各种网上教程，开始都很顺利。 然后突然有一个就网络超时访问不到了。 错误如下（Gateway） ERROR 16752 --- [ctor-http-nio-1] a.w.r.e.AbstractErrorWebExceptionHandler :[33ba6ddd-346] 500 Server Error for HTTP GET "/xxx/v2/api-docs" io.netty.chan
gateway网关中聚合swagger3
06-28
gateway（网关）和swagger3可以结合使用，以便显示和测试API的好处。Swagger是一种API规范，使API文档易于理解和使用。网关将客户端请求发送到API，并将API响应返回给客户端，可以通过swagger UI进行预览和测试。
gateway 配置swagger
weixin_44728369的博客
09-17 1283
1.引入架包 <dependency> <groupId>com.spring4all</groupId> <artifactId>swagger-spring-boot-starter</artifactId> <version>1.9.0.RELEASE</version> </dependency> 2
gateway集成swagger
qq_41988504的博客
09-26 2292
gateway集成swagger1、本次集成依赖gateway和swagger版本2、swagger配置3、重要事项（看看少踩坑）‼️4、gateway配置 因为gateway没有web包所以需要配置5、效果图6、有其他问题请留言评论，帮助到你请帮忙点个关注+赞谢谢???? 简单粗暴直接上代码???? 1、本次集成依赖gateway和swagger版本 <!--gateway网关依赖--> <dependency> <groupId
Gateway 整合 swagger 踩坑
qwertyu0103的博客
09-22 2354
一、导入依赖 注意版本问题，这里的swagger-bootstrap-ui依赖版本使用1.8.9不要使用1.9.6，不然不会加载 /swagger-resource <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2
springcloud-gateway网关聚合swagger实现多个服务接口切换
热门推荐
toBeMN的博客
10-15 2万+
正经学徒，佛系记录，不搞事情 springcloud是由多个不同的springboot服务组成的，微服务使用swagger有两种方法，如下： 方法一：（不推荐，但是是方法二的前置条件） 对每个需要生成接口的项目集成swagger，具体方法点击查看 然后启动所有的项目，需要查看不同服务的接口时去访问不同的地址：http://{ip}:{port}/swagger-ui.html 缺陷很...
Swagger整合Gateway网关
Dreamer.
03-06 5733
1.添加maven依赖 <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</arti...
Spring Cloud Gateway集成Swagger实现微服务接口文档统一管理及登录访问
五道口
10-18 8177
本文将介绍如何在微服务中使用Swagger网关来统一管理所有微服务的接口文档，并通过实现登录后才能访问Swagger文档，以确保接口数据的安全访问。在开始之前，需要假设你已经完成了的相关配置，并且已经了解了基本的网关配置知识。本文将不再赘述Gateway的配置，只介绍在此基础上如何配置Swagger来管理所有微服务，并通过账号密码来管理Swagger的访问。
用swagger-ui展示不同路径多个项目的接口文档
u013796473的博客
09-14 1万+
首先得安装node 1，在定好路径下创建空文件夹node_app mkdir node_app; 2,cd node_app     nom init(一直enter) 3,安装express npm install express --save 4，创建index.js vim index.js 5,把代码贴到index.js中 var exp
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值