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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java 获取日期的几天前,几个月前和几年前的实例

    java 获取日期的几天前,几个月前和几年前的实例

    下面小编就为大家带来一篇java 获取日期的几天前,几个月前和几年前的实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • IDEA实用好用插件推荐及使用方法教程详解(必看)

    IDEA实用好用插件推荐及使用方法教程详解(必看)

    这篇文章主要介绍了IDEA实用好用插件推荐及使用方法教程,本文通过实例截图相结合给大家介绍的非常详细,对大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-04-04
  • java 中内部类的实例详解

    java 中内部类的实例详解

    这篇文章主要介绍了java 中内部类的实例详解的相关资料,希望通过本文能帮助到大家,需要的朋友可以参考下
    2017-09-09
  • idea常用的18个设置(程序员必不可少)

    idea常用的18个设置(程序员必不可少)

    这篇文章主要给大家介绍了关于idea常用的18个设置,这些对程序员们来说必不可少,idea开发常用基本且非常实用的配置,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-08-08
  • Java编程rabbitMQ实现消息的收发

    Java编程rabbitMQ实现消息的收发

    RabbitMQ是一个在AMQP基础上完成的,可复用的企业消息系统,本文通过实例来给大家分享通过操作rabbitMQ实现消息的收发,感兴趣的朋友可以参考下。
    2017-09-09
  • 10个Java解决内存溢出OOM的方法详解

    10个Java解决内存溢出OOM的方法详解

    在Java开发过程中,有效的内存管理是保证应用程序稳定性和性能的关键,不正确的内存使用可能导致内存泄露甚至是致命的OutOfMemoryError(OOM),下面我们就来学习一下有哪些解决办法吧
    2024-01-01
  • spring+shiro 整合实例代码详解

    spring+shiro 整合实例代码详解

    本文通过实例代码给大家介绍spring+shiro 整合的过程,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-10-10
  • SpringBoot 如何将项目打包成 jar 包

    SpringBoot 如何将项目打包成 jar 包

    这篇文章主要介绍了SpringBoot如何将项目打包成jar包,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-08-08
  • SpringBoot整合ShardingSphere5.x实现数据加解密功能(最新推荐)

    SpringBoot整合ShardingSphere5.x实现数据加解密功能(最新推荐)

    这篇文章主要介绍了SpringBoot整合ShardingSphere5.x实现数据加解密功能,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-06-06
  • springboot配置文件读取pom文件信息方式

    springboot配置文件读取pom文件信息方式

    这篇文章主要介绍了springboot配置文件读取pom文件信息方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02

最新评论