springboot2整合swagger2
整合swagger2
1、导入swagger依赖
<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>
2、编写配置类
@Configuration
@EnableSwagger2
public class Swagger2Config {
/**
* 用于配置swagger2,包含文档基本信息
* 指定swagger2的作用域(这里指定包路径下的所有API)
* @return Docket
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//指定需要扫描的controller
.apis(RequestHandlerSelectors.basePackage("com.fanqie.springboot2.swagger.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* 构建文档基本信息,用于页面显示,可以包含版本、
* 联系人信息、服务地址、文档描述信息等
* @return ApiInfo
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//标题
.title("Spring Boot2中采用Swagger2构建RESTful APIs")
.description("通过访问swagger-ui.html,实现接口测试、文档生成")
.termsOfServiceUrl("http://localhost:8080")
//设置联系方式
.contact(new Contact("西红柿丶番茄", "https://blog.csdn.net/p_programmer", "xxxxx@qq.com"))
.version("1.0")
.build();
}
}
3、编写控制层注解
4、验证
- 计划任务
- [] 完成任务