Gateway集成swagger3.0

最新推荐文章于 2024-07-12 10:20:27 发布
最新推荐文章于 2024-07-12 10:20:27 发布
阅读量4.1k 收藏 19
点赞数 5
文章标签： spring boot 网关 spring cloud alibaba java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34640883/article/details/113706537
版权
一、依赖
			<!--swagger-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-boot-starter</artifactId>
                <version>3.0.0</version>
            </dependency>
            
			 <!--swagger-ui  这里是用了一个好看一点ui界面-->
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>swagger-bootstrap-ui</artifactId>
                <version>1.9.6</version>
            </dependency>

每一个微服务和 gateway都要这个依赖

微服务 的swagger配置

第一个版本

/**
 * 文件名: SwaggerConfig
 * 创建者: 友
 * 创建日期: 2021/1/25 11:00
 * 邮箱: 1738743304.com !
 * 描述: TODO
 */
@Configuration
public class SwaggerConfig {

	@Value("${swagger.enable:true}")
	private Boolean enable;

	@Bean
	public Docket api() {
		return new Docket(DocumentationType.OAS_30)
					   //资源
				       .globalResponses(HttpMethod.GET, new ArrayList<>())
				       .globalResponses(HttpMethod.PUT, new ArrayList<>())
				       .globalResponses(HttpMethod.POST, new ArrayList<>())
				       .globalResponses(HttpMethod.DELETE, new ArrayList<>())
					   //是否启动
				       .enable(enable)
					   //头部信息
				       .apiInfo(apiInfo())
				       .select()
				       /**
				        * RequestHandlerSelectors,配置要扫描接口的方式
				        * basePackage指定要扫描的包
				        * any()扫描所有，项目中的所有接口都会被扫描到
				        * none()不扫描
				        * withClassAnnotation()扫描类上的注解
				        * withMethodAnnotation()扫描方法上的注解
				        */
				       .apis(RequestHandlerSelectors.any())
					   //过滤某个路径
				       .paths(PathSelectors.any())
				       .build()
					   //协议
				       .protocols(newHashSet("https", "http"))
				       .securitySchemes(securitySchemes())
				       .securityContexts(securityContexts());
	}



    //配置Swagger 信息 = ApiInfo
    private ApiInfo apiInfo()
    {
        return new ApiInfo("小唐的Api文档",
                "好好看文档",
                "1.0",
                "xiaotangstudio.cn",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>());
    }
	/**
	 * 设置接口单独的授权信息
	 */
	private List<SecurityScheme> securitySchemes() {
		return Collections.singletonList(new ApiKey("BASE_TOKEN", "token", "header"));
	}

	/**
	 * 授权信息全局应用
	 */
	private List<SecurityContext> securityContexts() {
		return Collections.singletonList(
				SecurityContext.builder()
						.securityReferences(
								Collections.singletonList(new SecurityReference("BASE_TOKEN",
										new AuthorizationScope[]{new AuthorizationScope("global", "")}
								)))
						//.forPaths(PathSelectors.any())
						.build()
		);
	}

	@SafeVarargs
	private final <T> Set<T> newHashSet(T... ts) {
		if (ts.length > 0) {
			return new LinkedHashSet<>(Arrays.asList(ts));
		}
		return null;
	}
}

第二个版本 （要使用ui时推荐用这个）

@Configuration

public class SwaggerConfig implements WebMvcConfigurer {
    //配置了Swagger的Docket的bean实例
    //enable是否启动swagger，如果为False则Swagger不能在浏览器访问
    @Bean
    public Docket docket() {
        Set<String> set = new HashSet<>();
        set.add("https");
        set.add("http");
        return new Docket(DocumentationType.SWAGGER_2).pathMapping("/")
                .enable(true)//定义是否开启swagger，false为关闭，可以通过变量控制
                // 微信关注开发者技术前线：定义是否开启swagger，false为关闭，可以通过变量控制
                .apiInfo(apiInfo())//将api的元信息设置为包含在json ResourceListing响应中。
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xiaotang.blog"))
                //paths()过滤什么路径
                .paths(PathSelectors.any())
                .build()
                .protocols(set)// 支持的通讯协议集合
                .securitySchemes(securitySchemes())// 授权信息设置，必要的header token等认证信息
                .securityContexts(securityContexts());// 授权信息全局应用
    }
    //作者信息
    Contact contact = new Contact("小唐","xiaotangstudio.cn","1738743304@qq.com");

    //配置Swagger 信息 = ApiInfo
    private ApiInfo apiInfo()
    {
        return new ApiInfo("小唐的Api文档",
                "好好看文档",
                "1.0",
                "xiaotangstudio.cn",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>());
    }
    /**
     * 设置授权信息
     */
    private List<SecurityScheme> securitySchemes()
    {
       List<ApiKey> result = new ArrayList<>();
       ApiKey apiKey = new ApiKey("Authorization","Authorization" ,"Header" );
       result.add(apiKey);
       return  Collections.singletonList(apiKey);
    }
    /**
     * 授权信息全局应用
     */
    private List<SecurityContext> securityContexts() {
        return Collections.singletonList(
                SecurityContext.builder()
                        .securityReferences(Collections.singletonList(new SecurityReference("Authorization", new AuthorizationScope[]{new AuthorizationScope("global", "Authorization")})))
                        .build()
        );
    }

}

单个微服务 目录结构
在这里插入图片描述

gateway 的swagger配置


/**
 * swagger的配置类
 *
 * @author teler
 */
@Component
@Primary
public class MySwaggerResourcesProvider implements SwaggerResourcesProvider {

    /**
     * swagger3默认的url后缀
     */
    private static final String SWAGGER2URL = "/v3/api-docs"; //要使用ui的话 改成v2 不然会出bug  比如有的地方 没有输入框
    /**
     * 网关路由
     */
    private final RouteLocator routeLocator;

    /**
     * 网关应用名称
     */
    @Value("${spring.application.name}")
    private String self;

    @Autowired
    public MySwaggerResourcesProvider(RouteLocator routeLocator) {
        this.routeLocator = routeLocator;
    }

    /**
     * 对于gateway来说这块比较重要 让swagger能找到对应的服务
     *
     * @return
     */
    @Override
    public List<SwaggerResource> get() {
        List<SwaggerResource> resources = new ArrayList<>();
        List<String> routeHosts = new ArrayList<>();
        // 获取所有可用的host：serviceId
        routeLocator.getRoutes().filter(route -> route.getUri().getHost() != null)
                .filter(route -> !self.equals(route.getUri().getHost()))
                .subscribe(route -> routeHosts.add(route.getUri().getHost()));

        // 记录已经添加过的server
        Set<String> dealed = new HashSet<>();
        routeHosts.forEach(instance -> {
            // 拼接url
            String url = "/" + instance.toLowerCase() + SWAGGER2URL;
            if (!dealed.contains(url)) {
                dealed.add(url);
                SwaggerResource swaggerResource = new SwaggerResource();
                swaggerResource.setUrl(url);
                swaggerResource.setName(instance);
                resources.add(swaggerResource);
            }
        });
        return resources;
    }
}

gateway 目录结构
在这里插入图片描述

测试访问

两个访问地址 （都是gateway的ip地址和端口 , 我这里端口80 可以不写）

原始ui： http://localhost/swagger-ui/index.html

在这里插入图片描述

好看一点的ui：http://localhost/doc.html

在这里插入图片描述

步骤总结

1、导入依赖
2、配置每一个微服务的swagger
3、配置gateway的swagger

注意点

1、每一个微服务的swagger 要自测通过
2、使用ui时 记得把gateway的配置改成v2 不然可能没有输入框 ，每一个微服务推荐使用 第二个版本
在这里插入图片描述

完整依赖

父依赖
    <!--统一版本号管理-->
    <properties>
        <junit.version>4.13.1</junit.version>
        <lombok.version>1.18.16</lombok.version>
        <log4j.version>1.2.17</log4j.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>
    <!--    总包管理 dependencyManagement-->
    <!--     包管理 dependencies-->
    <dependencyManagement>
        <dependencies>
            <!-- springcloud依赖-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>2020.0.0</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- spring-cloud-alibaba依赖-->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2.2.4.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- springboot依赖-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.4.2</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--===============数据库===============-->
            <!--jdbc-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
            </dependency>
            <!-- druid-->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.2.4</version>
            </dependency>
            <!-- mybatis-plus-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.4.2</version>
            </dependency>
            <!--mybatis-plus 代码生成器依赖-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.1.tmp</version>
            </dependency>
            <!--freemarker-->
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
                <version>2.3.30</version>
            </dependency>
            <!--swagger-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-boot-starter</artifactId>
                <version>3.0.0</version>
            </dependency>
            <!--mybatis SpringBoot 启动器-->
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.1.4</version>
            </dependency>
            <!--mysql-connector-java-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.22</version>
            </dependency>

            <!--===============日志测试===============-->

            <!-- logback-->
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-core</artifactId>
                <version>1.2.3</version>
            </dependency>
            <!-- junit-->
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
            </dependency>
            <!-- lombok-->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </dependency>
            <!-- log4j-->
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
            </dependency>
            <!--jjwt -->
            <dependency>
                <groupId>io.jsonwebtoken</groupId>
                <artifactId>jjwt</artifactId>
                <version>0.9.1</version>
            </dependency>
            <!--swagger-ui -->
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>swagger-bootstrap-ui</artifactId>
                <version>1.9.6</version>
            </dependency>


            <!-- https://mvnrepository.com/artifact/org.springframework.security/spring-security-jwt -->
            <dependency>
                <groupId>org.springframework.security</groupId>
                <artifactId>spring-security-jwt</artifactId>
                <version>1.1.1.RELEASE</version>
            </dependency>
            <!-- https://mvnrepository.com/artifact/org.springframework.security.oauth.boot/spring-security-oauth2-autoconfigure -->
            <dependency>
                <groupId>org.springframework.security.oauth.boot</groupId>
                <artifactId>spring-security-oauth2-autoconfigure</artifactId>
                <version>2.4.2</version>
            </dependency>

        </dependencies>

    </dependencyManagement>
    <!--解决资源导出问题-->
    <build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                    <include>**/*.yml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>
单个微服务依赖
 <dependencies>
        <!--alibaba-nacos-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--fastjson-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.51</version>
        </dependency>

        <!--spring-cloud-starter-oauth2-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-oauth2</artifactId>
            <version>2.2.4.RELEASE</version>
        </dependency>
        <!--spring-security-jwt -->
        <dependency>
            <groupId>org.springframework.security</groupId>
            <artifactId>spring-security-jwt</artifactId>
        </dependency>


        <!-- /spring-cloud-starter-security -->
        <!--        <dependency>-->
        <!--            <groupId>org.springframework.cloud</groupId>-->
        <!--            <artifactId>spring-cloud-starter-security</artifactId>-->
        <!--            <version>2.2.4.RELEASE</version>-->
        <!--        </dependency>-->
        <!--==============================================================-->

        <!--redis-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!--jackson-databind-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>
        <!--swagger-bootstrap-ui-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.javassist</groupId>
                    <artifactId>javassist</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!--jjwt -->
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt</artifactId>
        </dependency>
        <!--spring-security-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
        </dependency>
        <!--freemarker-->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
        </dependency>
        <!--mybatis-plus 代码生成器依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
        </dependency>
        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>
        <!--mysql-connector-java-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--druid-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--log4j-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
        </dependency>
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--热部署工具-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>
gateway依赖
    <dependencies>
        <!--alibaba-nacos-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--loadbalancer-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
        </dependency>

        <!--swagger-bootstrap-ui-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.javassist</groupId>
                    <artifactId>javassist</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
xiaotangstudio
关注
Gateway+Swagger2配置聚合文档
我的博客
04-25 1831
Spring Cloud Gateway网关模块聚合各微服务的Swagger接口文档 效果如下图： 相关pom依赖 <!-- 网关路由代理 (仅网关)--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</arti
springcloud gateway集成swagger3实现API统一入口
weixin_40954354的博客
11-04 1196
项目使用springcloud gateway作为网关，统一路由各个服务的请求。产品为微服务架构，每一个web controller聚合服务都需要暴露接口给前端（VUE组件实现swagger自动配置API出入参和类型）。在云原生背景下，暴露每个web聚合服务的路由运维成本高且使用不方便。因此使用网关作为open api入口，实现每个聚合服务的接入、访问和debug.
3、微服务整合Swagger3.0 - 网关Gateway聚合接口
cchqlh的博客
01-26 2056
微服务整合Swagger3.0，在网关Gateway聚合接口
Gateway 聚合swagger文档
最新发布
booleandev
07-12 401
‍在微服务架构下，通常每个微服务 都会使用 Swagger 来管理我们的接口文档，当微服务越来越多，接口查找管理无形中要浪费我们不少时间，因此，我们需要把其它系统的 Swagger 文档聚合到 Gateway ,方便我们统一查看接口文档。
Gateway整合Swagger3
qq_34667621的博客
10-11 647
enabled: true # false关闭swagger-ui界面 但不关闭openapi。//结合配置的route-路径(Path)，和route过滤，只获取有效的route节点。* SwaggerResource设置子服务的name、location、version。.description("更多请咨询服务开发者")//描述。.version("1.0")//版本。.title("接口文档")//标题。//取出gateway的route。（2）SwaggerConfig 配置类。
分布式接口文档的实现，Gateway集成Swagger3
weixin_40169609的博客
09-26 1652
最近在做一个分布式项目，目前到了整合阶段，突然发现接口文档十分分散，于是想要集成到一起。网上找了很多文章，对我都没有太大帮助，最后再几经辗转加上自己修改了一些代码后，终于成功了。 默认你的分布式架构已经搭建完毕，只差将全部的接口文档都整合到一个端口下。 如下： 第一步： 在你的Gateway和Provider中全部引入Jar： <!--swagger--> <dependency> <groupId>io...
Springcloud-Gateway整合swagger3
qq_43653951的博客
05-21 3479
Springcloud-Gateway整合swagger3 swagger的pom节点 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> 聚合swagger-u.
SpringCloudGateway整合swagger3文档
she8292802的博客
03-01 3161
SpringCloud项目中，微服务模块和网关模块必不可少。按照以前SpringBoot的模式，单个服务拥有自己的Api文档（Swagger文档），引入微服务后，多文档管理成了一个问题。我们需要统一一个入口方便前端同学查看。本篇文章就是把各个微服务的api文档，集成到网关服务下面。
Springboot+Spring Security+Swagger3.0:完美整合
一叶一菩提的博客
03-24 1681
是不是因为这个报错进来的 Unable to infer base url. This is common when using dynamic servlet registration or when the API is behind an API Gateway. The base url is the root of where all the swagger resources are served. For e.g. if the api is available at http://e
swagger3 设置值可以为空_swagger3.0使用及https问题处理
weixin_30674431的博客
12-30 1776
swagger 文档在日常开发中，用得比较多，往往我们都是手动配置，swagger3.0之后，直接就上了一个swagger-starter,用起来更方便了。swagger3.0发生了很多变化，比如包名、注解、访问路径等都有所变化。具体自己去体会了，我就是不多说了，直接开干。第一步： 基础准备1.一个springboot项目2.swagger3.0依赖io.springfoxspringfox-bo...
swagger所有相关jar包
06-10
7. **API质量管理**：Swagger可以结合其他工具，如API Gateway，实现API的监控、限流、安全控制等功能。 在实际项目中，你需要将Springfox的依赖加入到你的项目中，配置Swagger的相关属性，例如API的基本路径、版本...
SpringBoot 2 （Security）整合 Swagger 3 步骤及问题详解
成长笔记
07-29 3269
引入pom依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> Application增加@EnableOpenApi注解 Swagger3Config配置 @Co
【JAVA】在SpringCloud Alibaba 2021微服务Gateway网关项目中整合Swagger3
Hey-Girl
12-09 2623
hey-girl东拼西凑原创文章，若有歧义可留言，若需转载需标明出处 前言唠个五毛钱：想做到的效果，通过网关访问swagger地址，可以看到所有服务的API文档。这个要求不过份吧。 开始干活前，我就斗胆先给和我一样懵逼的兄弟扫盲下。不难发现，当我们百度搜索swagger的配置整合时候。我们总是会发现好多兄弟引入的包都不一样。给大家截图看看。下面这些是不是都是我们常见的包。看到五花八门的包是不是给整懵了。所以我就去找了下文档。潦草的学习了下。 swagger是什么？ 了表尊重,官网传送先放上swagger
SpringCloud - GATEWAY与SWAGGER3的集成与使用
记录并分享
06-30 1309
在基于SpringCloud的项目中，各个微服务都有基于SWAGGER的在线API文档，所以将SWAGGER在线构建API文档创建了一个公共的场景启动器。如果要查看多个API文档怎么办呢? 一般会输入不同的IP:PORT查看不同微服务的文档，这样比较麻烦，所以将SWAGGER与GATEWAY进行聚合和集成，仅仅通过切换即可方便的查看。......
springcloud alibaba gateway方式集成swagger3.0
hlvy
02-07 2979
springcloud alibaba gateway方式集成swagger3.0
springcloud gateway 整合swagger3.0.0
Teler的博客
12-30 5306
版本 swagger:3.0.0 pom添加 <!-- 这是gateway的如果不需要添加 --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <!-- 3.0版本只需要引入一个，不再像2.
gateway 配置swagger
weixin_44728369的博客
09-17 1282
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 2288
gateway集成swagger1、本次集成依赖gateway和swagger版本2、swagger配置3、重要事项（看看少踩坑）‼️4、gateway配置 因为gateway没有web包所以需要配置5、效果图6、有其他问题请留言评论，帮助到你请帮忙点个关注+赞谢谢???? 简单粗暴直接上代码???? 1、本次集成依赖gateway和swagger版本 <!--gateway网关依赖--> <dependency> <groupId
springcloud-gateway网关聚合swagger实现多个服务接口切换
fuck487的博客
11-17 1513
转: https://blog.csdn.net/qq_31748587/article/details/102563155
springboot集成swagger3.0
06-28
### 回答1： 要在Spring Boot项目中集成Swagger 3.0，您需要以下步骤： 1. 在pom.xml文件中添加Swagger的依赖 2. 在启动类中添加@EnableSwagger2注解 3. 创建一个Docket Bean，并配置Swagger信息 4. 在控制器类和API方法上添加Swagger注解，来生成API文档 5. 启动项目并访问http://localhost:端口/swagger-ui.html查看API文档 具体的实现方法可以参考Swagger的官方文档和示例代码。 ### 回答2： Swagger是一款流行的API文档工具，Swagger 3.0 是当前最新版本，提供了全新的设计风格和功能。Spring Boot 是一款非常优秀且流行的Java框架，能够轻松集成和搭建不同的应用。在构建RESTful web服务时，我们可能需要使用Swagger来进行API的文档化和测试。由于Spring Boot的优秀特性和灵活性，它可以很方便地与Swagger进行集成。 Spring Boot的Swagger集成，主要依赖于两个库，它们分别是Swagger UI和Swagger Core。Swagger UI库是提供了一个交互式的Web页面，可以让我们很方便地查看和测试API。Swagger Core库则是提供了注解和解析功能，可以实现和扫描类、方法和参数的注解，最后生成API文档。 那么接下来，我将简单介绍在Spring Boot中如何集成Swagger 3.0，并说明如何使用它来生成我们需要的API文档。 首先，在你的Spring Boot项目中引入Swagger UI和Swagger Core的依赖库，建议使用最新版本，这样可以获得更好的性能和支持： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0-SNAPSHOT</version> </dependency> ``` 然后，在入口类（通常是Applicaton类）上添加注解@EnableSwagger2。例如： ```java @SpringBootApplication @EnableSwagger2 public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` 接下来，我们需要配置Swagger的基础信息，例如API文档的标题、描述和版本号等。在Spring Boot中，可以在application.yml或者application.properties配置文件中添加以下内容： ```yaml springfox.documentation.swagger-ui.enabled=true springfox.documentation.swagger-ui.title=My Awesome API Doc springfox.documentation.swagger-ui.description=Description for My Awesome API Doc springfox.documentation.swagger-ui.version=1.0 springfox.documentation.swagger-ui.terms-of-service-url=http://www.mycompany.com/terms springfox.documentation.swagger-ui.contact.name=API Support springfox.documentation.swagger-ui.contact.url=http://www.mycompany.com/support springfox.documentation.swagger-ui.contact.email=support@mycompany.com springfox.documentation.swagger-ui.license.name=Apache 2.0 springfox.documentation.swagger-ui.license.url=http://www.apache.org/licenses/LICENSE-2.0.html ``` 之后，我们需要在Controller层的类或者方法上加上Swagger的注解来描述API。例如： ```java @RestController public class MyController { @ApiOperation(value = "Get username", notes = "Return username by user id") @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = String.class), @ApiResponse(code = 500, message = "Internal server error") }) @GetMapping("/users/{id}") public String getUser(@PathVariable(name = "id") Long id) { return "user-" + id; } } ``` 以上示例中，用到的注解包括：@ApiOperation，用来定义操作方法的描述信息；@ApiResponses，用来定义操作方法的返回结果；@GetMapping，用来定义Controller类的Get请求。 最后，我们需要访问Swagger UI的页面，在浏览器地址栏输入http://localhost:8080/swagger-ui/index.html，即可查看到API文档的Web界面。在UI界面上，我们可以看到API的基本信息、请求参数、响应结果等内容。同时，在UI界面上，也可以直接对API进行测试并调试。特别是，在操作全局变量或者数据库的情况下，使用Swagger可帮助我们大大提高开发效率和减少错误。 ### 回答3： Swagger是一个开源的API框架，可以生成API文档和测试客户端，并提供了可视化的UI让用户直接测试API。而Spring Boot是一个非常流行的Java框架，它简化了Java web应用的开发。针对这两个框架的结合，可以实现在Spring Boot中集成Swagger，从而给Java web应用带来更加便捷的API文档和测试方式。本文详细介绍了如何在Spring Boot中集成Swagger3.0。 1、引入Swagger3.0依赖 首先，我们需要在pom.xml文件中引入Swagger3.0的依赖包： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 2、配置Swagger3.0 在Spring Boot的配置文件application.yml中，我们需要添加Swagger3.0的配置信息。具体而言，需要添加以下内容： ```yaml springfox: documentation: swagger-ui: enabled: true # 是否启用Swagger UI springfox: documentation: enabled: true # 是否启用Swagger文档 swagger-ui: enabled: true # 是否启用Swagger UI title: API文档 # Swagger UI的标题 description: API接口文档 # Swagger UI的描述信息 version: 1.0.0 # Swagger UI的版本信息 base-package: com.example.demo.controller # 扫描API文档所在的controller包 ``` 3、编写API文档 在Java开发中，通常通过注解的方式来提供API文档。Swagger3.0也不例外，它提供了一些注解，用于描述API的基本信息、请求参数、响应参数等。举个例子，下面是一个简单的UserController，其中涉及了Swagger3.0的注解： ```java @RestController @RequestMapping("/user") public class UserController { @ApiOperation(value = "获取用户详细信息", notes = "根据用户的ID来获取用户详细信息") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "int", paramType = "path") @GetMapping("/{id}") public User getUser(@PathVariable int id) { // 根据id获取用户信息 return user; } } ``` 其中，@ApiOperation注解用于描述API接口的基本信息，包括接口名称、接口说明等；@ApiImplicitParam注解则用于描述请求参数的基本信息，包括参数名称、参数类型、是否必填等。 4、访问Swagger UI 在完成上述步骤之后，我们就可以访问Swagger UI了。默认情况下，Swagger UI的URL为http://localhost:8080/swagger-ui/index.html，其中8080是Spring Boot应用的端口号，可以根据实际情况进行调整。在Swagger UI中，可以看到所有API接口的详细信息，包括请求参数、响应参数等。 总结 通过上述步骤，我们就可以在Spring Boot中集成Swagger3.0，方便的生成API文档并提供可视化的UI来测试API。在真实的开发环境中，我们可以根据实际需求来调整Swagger3.0的配置，以便更好的满足我们的开发需求。
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值