Swagger API 文档 | SpringCloudGateway 集成 SpringDoc

本文主要是介绍Swagger API 文档 | SpringCloudGateway 集成 SpringDoc,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 工作原理
    • 方案 1:配置 swagger-ui.urls
    • 方案 2:通过路由定义动态配置
  • 具体案例
    • 第 1 步:导入代码
    • 第 2 步:配置 Swagger Url 列表
    • 第 3 步:启动程序
    • 第 4 步:查看注册中心
    • 第 5 步:访问网关 Swagger UI
  • 相关博文

😎 本节目标: Spring Cloud Gateway 集成 SpringDoc,实现网关聚合多个微服务的 Swagger。
👉 版本说明

  • JDK 17
  • SpringBoot 3.2.1
  • SpringCloud Gateway 4.1.0
  • SpringDoc 2.3.0

工作原理

Spring Cloud Gateway 中聚合 Swagger,实现通过网关访问多个项目的 Swagger。
🚀 SpringBoot 集成 SpringDoc 原理

  • 先添加依赖,比如 springdoc-openapi-starter-webmvc-ui
  • 然后即可获得 API Doc 及 Swagger UI 的能力

🚀 Spring Cloud Gateway 集成 SpringDoc 原理

  • 添加依赖,比如 springdoc-openapi-starter-webflux-ui
  • 然后即可获得 API Doc 及 Swagger UI 的能力
  • 定义下游微服务的 API Doc 的访问地址,即可实现访问

😎 说白了吧 😎

  • SpringBoot 集成 SpringDoc,就是先定义出 API Doc,然后 Swagger UI 访问 API Doc,从而展现页面。
  • Spring Cloud Gateway 集成 SpringDoc 也类似,不同点在于:
    • 一个是基于 MVC,一个是基于 WebFlux
    • 一个是访问一个 API Doc,一个是访问多个 API Doc,就是这么简单。

方案 1:配置 swagger-ui.urls

在配置文件中,通过 springdoc.swagger-ui.urls 即可配置各个微服务的 API Doc 访问地址。
这样,在网关聚合 Swagger UI 中即可展示出多个微服务的 Swagger Api Doc 定义。
示例如下:

  • name:定义为微服务的名称,用于展示
  • url:访问微服务的 API Doc 的 url,这里使用的是通过网关访问的路由地址
springdoc:cache:disabled: trueswagger-ui:urls:- name: employeeurl: /employee/v3/api-docs- name: departmenturl: /department/v3/api-docs- name: organizationurl: /organization/v3/api-docs

这篇关于Swagger API 文档 | SpringCloudGateway 集成 SpringDoc的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/905875

相关文章

SpringBoot集成EasyPoi实现Excel模板导出成PDF文件

《SpringBoot集成EasyPoi实现Excel模板导出成PDF文件》在日常工作中,我们经常需要将数据导出成Excel表格或PDF文件,本文将介绍如何在SpringBoot项目中集成EasyPo... 目录前言摘要简介源代码解析应用场景案例优缺点分析类代码方法介绍测试用例小结前言在日常工作中,我们经

Java实现预览与打印功能详解

《Java实现预览与打印功能详解》在Java中,打印功能主要依赖java.awt.print包,该包提供了与打印相关的一些关键类,比如PrinterJob和PageFormat,它们构成... 目录Java 打印系统概述打印预览与设置使用 PageFormat 和 PrinterJob 类设置页面格式与纸张

Spring Security常见问题及解决方案

《SpringSecurity常见问题及解决方案》SpringSecurity是Spring生态的安全框架,提供认证、授权及攻击防护,支持JWT、OAuth2集成,适用于保护Spring应用,需配置... 目录Spring Security 简介Spring Security 核心概念1. ​Securit

SpringBoot+EasyPOI轻松实现Excel和Word导出PDF

《SpringBoot+EasyPOI轻松实现Excel和Word导出PDF》在企业级开发中,将Excel和Word文档导出为PDF是常见需求,本文将结合​​EasyPOI和​​Aspose系列工具实... 目录一、环境准备与依赖配置1.1 方案选型1.2 依赖配置(商业库方案)二、Excel 导出 PDF

SpringBoot改造MCP服务器的详细说明(StreamableHTTP 类型)

《SpringBoot改造MCP服务器的详细说明(StreamableHTTP类型)》本文介绍了SpringBoot如何实现MCPStreamableHTTP服务器,并且使用CherryStudio... 目录SpringBoot改造MCP服务器(StreamableHTTP)1 项目说明2 使用说明2.1

spring中的@MapperScan注解属性解析

《spring中的@MapperScan注解属性解析》@MapperScan是Spring集成MyBatis时自动扫描Mapper接口的注解,简化配置并支持多数据源,通过属性控制扫描路径和过滤条件,利... 目录一、核心功能与作用二、注解属性解析三、底层实现原理四、使用场景与最佳实践五、注意事项与常见问题六

Spring的RedisTemplate的json反序列泛型丢失问题解决

《Spring的RedisTemplate的json反序列泛型丢失问题解决》本文主要介绍了SpringRedisTemplate中使用JSON序列化时泛型信息丢失的问题及其提出三种解决方案,可以根据性... 目录背景解决方案方案一方案二方案三总结背景在使用RedisTemplate操作redis时我们针对

Java中Arrays类和Collections类常用方法示例详解

《Java中Arrays类和Collections类常用方法示例详解》本文总结了Java中Arrays和Collections类的常用方法,涵盖数组填充、排序、搜索、复制、列表转换等操作,帮助开发者高... 目录Arrays.fill()相关用法Arrays.toString()Arrays.sort()A

Spring Boot Maven 插件如何构建可执行 JAR 的核心配置

《SpringBootMaven插件如何构建可执行JAR的核心配置》SpringBoot核心Maven插件,用于生成可执行JAR/WAR,内置服务器简化部署,支持热部署、多环境配置及依赖管理... 目录前言一、插件的核心功能与目标1.1 插件的定位1.2 插件的 Goals(目标)1.3 插件定位1.4 核

如何使用Lombok进行spring 注入

《如何使用Lombok进行spring注入》本文介绍如何用Lombok简化Spring注入,推荐优先使用setter注入,通过注解自动生成getter/setter及构造器,减少冗余代码,提升开发效... Lombok为了开发环境简化代码,好处不用多说。spring 注入方式为2种,构造器注入和setter