<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
@Configuration
@EnableSwagger2
public class Swagger2Configuration {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//暴露API的包名
.apis(RequestHandlerSelectors.basePackage("com.h2t.study.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//页面标题
.title("SpringBoot整合Swagger2")
.version("1.0")
//描述
.description("API 描述")
.build();
}
}
@RestController
public class TestController {
@ApiOperation(value = "测试接口",notes = "传入字符串",httpMethod = "GET")
@ApiImplicitParam(dataType = "string",name = "str",value = "字符串",required = true)
@GetMapping("/test")
public Object test(@RequestParam("str") String str) {
return str;
}
}
访问http://ip:port/swagger-ui.html,访问页面如下:
访问接口: