springboot整合swagger-bootstrap-ui

官网路径：https://doc.xiaominfo.com/knife4j/
1.先导入pom文件

<!--swagger-api 依赖开始-->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>swagger-bootstrap-ui</artifactId>
			<version>1.9.6</version>
		</dependency>
		<!--swagger-api 依赖结束-->

2.写配置文件

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
 * @author Administrator
 * @PACKAGE_NAME: 
 * @company:
 * @USER:小清新
 * @date: 2021年09月08日 10:06
 * @PROJECT_NAME: CGCP
 **/
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        //http://ip地址:端口/项目名/swagger-ui.html#/
        ApiInfo apiInfo = new ApiInfoBuilder()
                //网站标题
                .title("当代好课堂")
                //网站描述
                .description("项目名称swagger RESTful APIs......")
                //版本
                .version("1.0")
                //联系人
                .contact(new Contact("小清新","https://mp.csdn.net/?spm=1000.2115.3001.4503","12504*****@qq.com"))
                //协议
                .license("The Apache License")
                //协议url
                .licenseUrl("http://www.baidu.com")
                .build();
                //swagger版本
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                //扫描那些controller
                .apis(RequestHandlerSelectors.basePackage("com.ewaytek.edf.web.controllers"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo);
    }
}

3.测试demo

import io.swagger.annotations.ApiOperation;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;


/**
 * @author Administrator
 * @PACKAGE_NAME: com.ewaytek.edf.web.controllers.demo.swagger
 * @company:
 * @USER:小清新
 * @date: 2021年09月08日 10:23
 * @PROJECT_NAME: CGCP
 **/
@RestController
@RequestMapping("/testSwagger")
public class SwaggerController {

    @RequestMapping(value = "/testSwaggerDemo", method = RequestMethod.GET)
    @ApiOperation("用来测试swagger")
    public SwaggerEntity testSwaggerDemo(SwaggerEntity swaggerEntity){
        return swaggerEntity;
    }
}

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * @author Administrator
 * @PACKAGE_NAME: com.ewaytek.edf.web.controllers.demo.swagger
 * @company:
 * @USER:小清新
 * @date: 2021年09月08日 10:25
 * @PROJECT_NAME: CGCP
 **/
@Data
public class SwaggerEntity {
    @ApiModelProperty(value = "姓名")
    private String name;

    @ApiModelProperty(value = "年龄")
    private Integer age;
}

swagger2使用说明：
@Api：用在类上，说明该类的作用
@ApiOperation：用在方法上，说明方法的作用
@ApiIgnore：使用该注解忽略这个API
@ApiImplicitParams：用在方法上包含一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
paramType：参数放在哪个地方
header–>请求参数的获取：@RequestHeader
query–>请求参数的获取：@RequestParam
path（用于restful接口）–>请求参数的获取：@PathVariable
body（不常用）
form（不常用）
name：参数名
dataType：参数类型
required：参数是否必须传
value：参数的意思
defaultValue：参数的默认值
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@ApiModel：描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：描述一个model的属性