SpringBoot整合Swagger2

SpringBoot整合Swagger2

1. pom文件引入依赖

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2. 添加配置文件
建立SwaggerConfig，并开启swagger

@Configuration
//开启swagger
@EnableSwagger2
public class SwaggerConfig {
 }

此时已经是可以使用swagger了。

3. 自定义一些swagger信息

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

    //配置了swagger的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //RequestHandlerSelectors 配置要扫描接口的方式
                //basePackage :指定要扫描的路径
                .apis(RequestHandlerSelectors.basePackage("com.hhmoon.admin.controller"))
                .build();
    }

    //配置swagger信息
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("lnw","Null","admin@qq.com");
        return  new ApiInfo("swagger文档",
                "123",
                "v1.0",
                "admin@qq.com",
                contact,
                "Apache 2.0",
                "123",
                new ArrayList<>());
    }
}