1.添加依赖
io.springfox
springfox-swagger-ui
2.4.0
io.springfox
springfox-swagger2
2.4.0
2.添加swagger2 配置类
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.documentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(documentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// 接口所在包路径
.apis(RequestHandlerSelectors.basePackage("com.demo.controller")).paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 标题
.title("Spring Boot 整合 Swagger2 构建 restful API")
// 创建人
.contact(new Contact("NoDeal", "", ""))
// 版本号
.version("0.0.1")
// 描述
.description("Api描述信息")
.build();
}
}
3.在启动类上添加@EnableSwagger2注解
4.访问 http://localhost:8080/swagger-ui.html#/
5. 相关注解
@Api("demo api")
@RestController
public class KettleController {
@Autowired
Service service;
@ApiOperation(value="测试接口")
@ApiImplicitParams({
@ApiImplicitParam(name = "startDate", value = "开始时间"),
@ApiImplicitParam(name = "endDate", value = "结束时间")
})
@GetMapping("test")
public String test(String startDate, String endDate){
return service.test(startDate,endDate);
}
}