Spring Boot整合swagger

一、整合swagger

1.pom.xml

pom.xml所需要添加的文件如下：

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2.创建配置文件SwaggerConfig

package com.ch.exercise.config.swagger;

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.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * swagger配置
 *
 * @author CH
 * @date 2021-08-23 9:28
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket productDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
        .select()
                //配置需要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.ch.exercise.controller"))
                //配置扫描的路径
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
        		//文档标题
                .title("接口文档")
                //文档介绍
                .description("系统后台文档API")
                //创建作者
                .contact("ccc")
                //版本
                .version("1.0").build();
    }
}

访问地址：http://localhost:端口/swagger-ui.html#/

二、补充

注解	作用域	介绍
@Api()	类	表示标识这个类是swagger的资源
@ApiOperation()	方法	表示一个http请求的操作
@ApiParam()	方法，参数，字段说明	表示对参数的添加元数据（说明或是否必填等）
@ApiModel()	类	表示对类进行说明，用于参数用实体类接收
@ApiModelProperty()	方法，字段	表示对model属性的说明或者数据操作更改
@ApiIgnore()	类，方法，方法参数	表示这个方法或者类被忽略
@ApiImplicitParam()	方法	表示单独的请求参数
@ApiImplicitParams()	方法	包含多个 @ApiImplicitParam