Spring Boot整合Swagger2

关于swagger2的阐述以及使用等此处不做描述。

整合步骤

整合之前需要先创建一个Spring Boot的web项目。

POM依赖导入

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

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

配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("整合演示API")
                .description("提供给XX调用和交互的API接口")
                .version("1.0")
                .build();
    }
}

• basePackage用于配置需要生成接口文档的包路径。
• apiInfo主要是针对生成的接口文档的标题，描述等的配置
• @EnableSwagger2注解不能省略

启动

启动项目并访问路径：http(s)://localhost:8080/swagger-ui.html