SpringBoot集成Swagger3代码实现方法

本篇文章小编给大家分享一下SpringBoot集成Swagger3代码实现方法，文章代码介绍的很详细，小编觉得挺不错的，现在分享给大家供大家参考，有需要的小伙伴们可以来看看。

一，什么是swagger?

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

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

官方网站:https://swa*gger*.io*/

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

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

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

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

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

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

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

二，SpringBoot 集成swagger3

pom.xml 集成Swagger3依赖

        
		
			io.springfox
			springfox-boot-starter
			3.0.0
			
				
					org.springframework.plugin
					spring-plugin-core
				
				
					org.springframework.plugin
					spring-plugin-metadata
				
			
		

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.*c*s*dn.net/zhouzhiwengang")
				.description("API接口")
				.contact(new Contact("https://blog.*c*s*dn.net/zhouzhiwengang","",""))
				.version("3.0").build();
    }
 
}

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

SpringBoot 访问Swagger3接口文档地址

默认接口访问地址:http://192.*1*6*8.0.1:5988/swagger-ui/

三，swagger3 注解标签使用

@ApiModel用于类上面说明功能

@ApiModelProperty用于字段上说明功能

示列截图：

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

@ApiOperation用来说明一个方法

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

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

示列截图：

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