springboot 整合swagger2

1.目录

1.springboot整合swagger2

2.springboot整合定时器

 2.springboot整合swagger2

        2.1什么是swagger2？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档 . 接口: controller相应的路径方法

        2.2为什么是swagger2

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

swagger2在线文档，会根据你后端的程序发生改变时，自动更新改变。

        2.3如何使用接口文档swagger2

               （1）导入相关依赖

<!--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 //开启SSwagger2注解驱动
public class SwaggerConfig {

    @Bean //把方法返回的数据对象交给spring管理
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2).groupName("qy163_7")
                .apiInfo(getinfo()).select().apis((RequestHandlerSelectors.basePackage("com.qwq.controller")))
                .build();

        return docket;
    }

    private ApiInfo getinfo() {
        Contact DEFAULT_CONTACT = new Contact("乔文庆", "http://www.baidu.com", "92100@qq.com");
        ApiInfo apiInfo = new ApiInfo("4.12测试", "4.12测试", "1.1.0", "http://www.baidu.com",
                DEFAULT_CONTACT, "第七组", "http://www.baidu.com", new ArrayList<VendorExtension>());
        return apiInfo;
    }

}

                （3）访问swagger在线文档

                   http://ip:port/doc.html

 

 2.4swaager中常用的注解

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

@Api（tags=“ ”）---------使用在controller类上

@ApiOperation(value=" ")----使用在接口方法上--- 对方法的说明

@ApiParam（value=“ ” ，name = " " ，required = true ）

@ApiModel-------在实体类上添加
@ApiModelProperty(value= '' '') 在参数上添加说明

 

3.springboot整合定时器

https://www.pppet.net/

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

场景： 比如定时发送短信， 定时删除oss冗余的文件

        3.1 导入相关依赖

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

         3.2配置定时器任务

@Component  // 交给spring容器管理
public class QuarzConfig {
    @Autowired
    private StudentMapper studentMapper;


    @Scheduled(cron = "0/3 * * * * ? ") // cron表达式， 每三秒执行一次
    public void show(){
        //定期查询student
        List<Student> studentList = studentMapper.selectList(null);
        System.out.println(studentList);

    }
}

             3.3开启定时器注解驱动

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

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

}