springboot整合Swagger

为什么需要Swagger？

前后端分离的时代，前端人员与后端人员分开，该需求的时候需要统一文档，规范创建了RESTful接口，使用Swagger文档就回比较快的操作文档；测试：前端在调用后端设计的接口，就可以在文档页面上进行快速的测试！

Maven导包

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

设计配置类SwaggerConfig

@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(Environment environment){

        //设置要显示的Swagger环境
        Profiles profiles=Profiles.of("dev","test");

        //判断是否在设定的环境中
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("Xuy")   //组名，用于在文档查
                .enable(flag)   //判断是否开启Swagger扫描
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xuy.swagger.controller")) //包的路径
                .build();
    }

    //配置Swagger信息
    @Bean
    public ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("Xuy", "https://me.csdn.net/weixin_44265189", "Xuy971019@163.com");

        return new ApiInfo("Xuy Swagger API文档",
                "Xuy",
                "v1.0",
                "https://me.csdn.net/weixin_44265189",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>());
    }
}

@EnableSwagger2启动swagger

RequestHandlerSelectors.配置扫描接口的方式
basePackage：指定包 常用
any：扫描全部
none：全部不扫描
withClassAnnotation:扫描类上的注解 如
withMethodAnnotation:扫描方法上的注解 如：RestController.class

如果要判断在开发环境的时候使用Swagger上线不适用的话，可以进行环境判断

 //设置要显示的Swagger环境
        Profiles profiles=Profiles.of("dev","test");

        //判断是否在设定的环境中
        boolean flag = environment.acceptsProfiles(profiles);

注意：在使用环境变化的时候的测试，注意端口的更换！

注释	注释位置
@ApiModel	entity的类介绍（请求类）
@ApiModelProperty	entity属性介绍 （请求类）
@ApiOperation	controller的方法介绍
@Api(tags = “信息”)	类介绍
@ApiImplicitParams	请求字段的介绍(一组)
@ApiImplicitParam	请求字段的介绍（一个）

参考：https://juejin.im/post/5afe490ff265da0b8c253411

启动后直接访问：http://localhost:8080/swagger-ui.html
根据自己的组昵称选择查看该组下的接口信息

为什么访问http://localhost:8080/swagger-ui.html？

因为在Swagger-ui下面设置了这个路径！

学习！