springboot整合swagger2

依赖:

<!--swagger! start-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
<!--swagger! end-->



新建类
@Configuration
@EnableSwagger2
public class SwaggerConfig {

@Value("${swagger.enable}")
private Boolean enable;
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.enable(enable)
.select()
.apis(RequestHandlerSelectors.basePackage("com"))
.paths(PathSelectors.any()).build();
}


private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("接口文档")
.termsOfServiceUrl("")
.contact(new Contact("wjs", "http://www.baidu.com", "15001086406@163.com"))
.version("1.0").build();
}
}

新建controller测试
@Controller
@Api(tags = "TestController", description = "测试swagger")
@RequestMapping(value = "/",method = RequestMethod.GET)
public class ocrSdkController {


@ApiOperation(value = "获图书细信息", notes = "根据url的id来获取详细信息")
@RequestMapping(value = "/bookDetail")
@ResponseBody
public Book getBook(@RequestParam(value="id",required=true,defaultValue="1")String id) {
Book book = new Book();
if(id.equals("1")) {
book.setId("1");
book.setName("十万个为什么");
book.setDec("啥都有");
book.setAuthor("作者1");
book.setCreateTime("2019/12/10");
}else {
book.setId("2");
book.setName("亿万个为什么");
book.setDec("啥都没有");
book.setAuthor("作者也没有");
book.setCreateTime("2019/12/10");
}
return book;
}
}
收工
http://localhost:8080/swagger-ui.html

注意
swagger.enable = true(对应上边的红色部分) 配置文件中加true可以访问swagger 生产可能不需要 只要不是true就行



posted @ 2019-12-10 17:38  简单的深度  阅读(476)  评论(0编辑  收藏  举报