Spring Cloud Gateway集成SpringDoc,集中管理微服务API

Spring Cloud Gateway 是一种网关服务,通常用于API路由、过滤和管理。SpringDoc 是一个Spring Boot应用程序,可以为Spring REST API生成Swagger UI文档。将Spring Cloud Gateway与SpringDoc集成可以提供一个集中的Swagger UI来查看所有微服务的API文档。

以下是一个简化的例子,展示如何将Spring Cloud Gateway与SpringDoc集成:

  1. 在Spring Cloud Gateway中添加依赖:



<dependencies>
    <!-- Spring Cloud Gateway -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <!-- SpringDoc -->
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-webflux-core</artifactId>
    </dependency>
</dependencies>
  1. 配置Spring Cloud Gateway以转发请求到后端服务,并设置SpringDoc的路由:



@Configuration
public class GatewayConfig {
 
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("service1", r -> r.path("/service1/**")
                        .uri("http://service1:8081")
                        .id("service1_route")
                )
                .route("service2", r -> r.path("/service2/**")
                        .uri("http://service2:8082")
                        .id("service2_route")
                )
                // 添加SpringDoc的路由
                .route("swagger-ui", r -> r.path("/swagger-ui/**")
                        .filters(f -> f.stripPrefix(1))
                        .uri("http://springdoc:8083")
                        .id("swagger_ui_route")
                )
                .build();
    }
}
  1. 在微服务中添加SpringDoc依赖并配置SpringDoc:



<dependencies>
    <!-- SpringDoc -->
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-core</artifactId>
    </dependency>
</dependencies>



@Configuration
public class SpringDocConfig {
 
    @Bean
    public OpenAPI customOpenAPI(@Value("${springdoc.version}") String appVersion) {
        return new OpenAPI()
                .info(new Info().title("微服务API文档")
                        .version(appVersion)
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")));
    }
}

确保每个微服务都有一个对应的SpringDoc实例,并且这些实例可以被Spring Cloud Gateway访问。

以上代码展示了如何通过Spring Cloud Gateway将对微服务的请求以及

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日