springboot整合swagger2

1.正文

1.1 什么是swagger2

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档 . 接口: controller相应的路径方法
Swagger2是一款前后端分离开发中非常实用的API管理工具，它可以帮助开发者根据约定规范自动生成API文档，并支持在线调试API接口，方便开发者快速构建高质量的Restful API。除此之外，Swagger2还支持许多功能，例如对API进行版本管理、验证、授权、模型转换等。它的优点在于简化了API的设计和调试过程，提高了开发效率和代码质量。

1.2 为什么是swagger2

目前的项目基本都是前后端分离，后端为前端提供接口的同时，还需同时提供接口的说明文档。但我们的代码总是会根据实际情况来实时更新，这个时候有可能会忘记更新接口的说明文档，造成一些不必要的问题。

1.3 如何使用接口文档swagger2

 <!--swagger2依赖-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.7.8</version>
        </dependency>

(2)创建一个配置类-swagger2

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2).groupName("QY163")
                .apiInfo(getInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.lht.controller"))
                .build();
        return docket;
    }

    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("卢海腾", "http://www.baidu.com", "120@qq.com");
        ApiInfo apiInfo=new ApiInfo("QY163学生管理系统", "QY163学生管理系统API", "1.1.0", "http://www.jd.com",
                DEFAULT_CONTACT, "志远科技", "http://www.aaa.com", new ArrayList<VendorExtension>());
        return apiInfo;
    }
}

（3）访问swagger在线文档

http://ip:port/swagger-ui.html路径

http://ip:port/doc.html

1.4 swagger中常用的注解

使用swagger注解对接口参数加以说明。

@Api（tags=""）====使用在controller类上

@ApiOperation(value="")====接口方法上 接口方法加以说明

@ApiParam(value = "",name = "",required = true)

@ApiModel====实体类

@ApiModelProperty===>实体类的属性说明

2. springboot整合定时器-quartz

https://www.pppet.net/

定时器: 在指定的时间执行相应的业务代码。

应用场景: 比如: 定时删除OSS中冗余的文件

三十分钟未支付---->取消订单。

定时发送短信---->11.11====>

(1)引入quartz依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>

(2)配置定时器任务

@Component //交于spring容器该类对象
public class QuarzConfig {
    @Autowired
    private StudentMapper studentMapper;
    @Scheduled(cron = "0/5 * * * * ? ")
    public void show(){
        //1.查询过期的订单
        List<Student> students = studentMapper.selectList(null);
        System.out.println(students );
        //2.删除过期的订单
    }
}

(3)开启定时器注解驱动

@SpringBootApplication
@MapperScan(basePackages = "com.lht.mapper")
@EnableSwagger2
@EnableScheduling //开启定时器注解
public class Lht412SpringbootApplication {

    public static void main(String[] args) {
        SpringApplication.run(Lht412SpringbootApplication.class, args);
    }

}