springboot简单的整合swagger

1.先在pom.xml文件种引入依赖

        <!-- swagger2 restful接口文档在线自动生成+功能测试-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

        <!--  美化界面 wangmx   -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.6</version>
        </dependency>

2.在启动类的目录下创建一个Swagger2类

/**
 * @Author:yangle
 * @Date:2020/11/3
 * @version:1.0
 */
//swagger2的配置文件，在项目的启动类的同级文件建立
@Configuration
@EnableSwagger2
//是否开启swagger，正式环境一般是需要关闭的（避免不必要的漏洞暴露！），可根据springboot的多环境配置进行设置
@ConditionalOnProperty(name = "swagger.enable",  havingValue = "true")
public class Swagger2 {
    // swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage("cn.xdf.springboot.controller")).paths(PathSelectors.any())
                .build();
    }
    // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title("Spring Boot 测试使用 Swagger2 构建RESTful API")
                // 创建人信息
                .contact(new Contact("yangle",  "",  ""))
                // 版本号
                .version("1.0")
                // 描述
                .description("API 描述")
                .build();
    }
}

3.在启动类加上@EnableSwagger2注解

4.swagger的使用

@RestController
@RequestMapping("tbAmmeterDay")
@Api(value = "/tbAmmeterDay",description = "日期电耗接口")
public class TbAmmeterDayController extends BaseController {

    @ApiOperation(value="日期汇总数据查询数据查询",notes = "日期汇总数据查询数据查询")
    @ApiImplicitParams({
            @ApiImplicitParam(name="proline",value = "生产线",dataType = "String",required = false),
            @ApiImplicitParam(name="startTime",value = "开始时间",dataType = "Date",required = false),
            @ApiImplicitParam(name="endTime",value = "结束时间",dataType = "Date",required = false),
    })
    @PostMapping("findAmmeterDaylyReport")
    public JsonResult findDaylyReport(

5.启动程序，访问http://localhost:8080/swagger-ui.html