SpringBoot集成Swagger3的实现

 更新时间:2021年12月29日 11:43:08   作者:在奋斗的大道  
本文主要介绍了SpringBoot集成Swagger3的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

一,什么是swagger?

1,  Swagger 是一个规范和完整的文档框架,

    用于生成、描述、调用和可视化 RESTful 风格的 Web 服务文档

    官方网站:https://swagger.io/

2,使用swagger要注意的地方:

     在生产环境中必须关闭swagger,

     它本身只用于前后端工程师之间的沟通,

     可以专门使用一台内部服务器来展示ui供访问,

     即使在这上面要做好安全措施

3,  因为swagger3.0.0已发布,本文使用了最新版

     如果有还在用2.x版本的请参考时注意区分

二,SpringBoot 集成swagger3

 pom.xml 集成Swagger3依赖

        <!-- swagger3 接口文档生成器 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>3.0.0</version>
			<exclusions>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-core</artifactId>
				</exclusion>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-metadata</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

Swagger3 配置对象定义

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
 
@Configuration
@EnableOpenApi
public class Swagger3Config {
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.digipower.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("在奋斗的大道上 - 微信预约查档系统").termsOfServiceUrl("https://blog.csdn.net/zhouzhiwengang")
				.description("API接口")
				.contact(new Contact("https://blog.csdn.net/zhouzhiwengang","",""))
				.version("3.0").build();
    }
 
}

SpringBoot 集成Swagger3 接口文档效果截图

 SpringBoot 访问Swagger3接口文档地址

默认接口访问地址:http://192.168.0.1:5988/swagger-ui/

三,swagger3 注解标签使用

@ApiModel用于类上面说明功能

@ApiModelProperty用于字段上说明功能

示列截图:

@Api用来指定一个controller中的各个接口的通用说明

@ApiOperation用来说明一个方法

@ApiImplicitParams:用来包含多个包含多个 @ApiImplicitParam

@ApiImplicitParam:用来说明一个请求参数 

示列截图:

 温馨提示:针对任何请求参数结构说明,请一定记得要添加@ApiParam 标签,如果不添加@ApiParam标签,在Swagger3文档中针对参数结构说明就是空

到此这篇关于SpringBoot集成Swagger3的实现的文章就介绍到这了,更多相关SpringBoot集成Swagger3内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot2底层注解@ConfigurationProperties配置绑定

    SpringBoot2底层注解@ConfigurationProperties配置绑定

    这篇文章主要介绍了SpringBoot2底层注解@ConfigurationProperties配置绑定,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • Java Spring拦截器案例详解

    Java Spring拦截器案例详解

    这篇文章主要介绍了Java Spring拦截器案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • javaweb实现文件上传小功能

    javaweb实现文件上传小功能

    这篇文章主要为大家详细介绍了javaweb实现文件上传功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-06-06
  • Mybatis与Hibernate的区别

    Mybatis与Hibernate的区别

    以前没怎么用过mybatis,只知道与hibernate一样是个orm数据库框架。随着使用熟练度的增加,发现它与hibernate区别是非常大的感兴趣的朋友通过本文一起学习吧
    2016-01-01
  • Java中自定义注解类及使用实例解析

    Java中自定义注解类及使用实例解析

    这篇文章主要介绍了Java中自定义注解类并使用过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • 关于设置Mybatis打印调试sql的两种方式

    关于设置Mybatis打印调试sql的两种方式

    这篇文章主要介绍了关于设置Mybatis打印调试sql的两种方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-08-08
  • SpringBoot快速构建应用程序方法介绍

    SpringBoot快速构建应用程序方法介绍

    这篇文章主要介绍了SpringBoot快速构建应用程序方法介绍,涉及SpringBoot默认的错误页面,嵌入式Web容器层面的约定和定制等相关内容,具有一定借鉴价值,需要的朋友可以参考下。
    2017-11-11
  • Spring Boot 3 整合 MinIO 实现分布式文件存储的全过程

    Spring Boot 3 整合 MinIO 实现分布式文件存储的全过程

    本文介绍了如何使用SpringBoot3和MinIO实现分布式文件存储,通过MinIO的分布式对象存储系统,可以解决传统单机文件存储方案在面对大规模数据和高并发访问时的不足,文章详细讲解了MinIO的安装、配置和使用,感兴趣的朋友一起看看吧
    2025-03-03
  • Java中使用SQLite数据库的实现示例

    Java中使用SQLite数据库的实现示例

    SQLite是一种嵌入式数据库引擎,可以在各种平台上使用,本文主要介绍了Java中使用SQLite数据库的实现示例,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • idea中安装VisualVM监控jvm的图文教程

    idea中安装VisualVM监控jvm的图文教程

    这篇文章主要介绍了idea中安装VisualVM监控jvm的教程,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-09-09

最新评论