Springboot项目快速搭建Swagger2.0

如今相信大部分公司都已经实现前后端分离的开发模式,所以前后端沟通成为不可避免的问题,怎么更加清晰明了的进行交接,API文档是不可避免的,所以Swagger还是值得推荐的

虽然也不是特别的满意,比如代码的移入性较高,可是总体来说看起来还是比较明了的

一、配置依赖:


Springboot项目快速搭建Swagger2.0_第1张图片

io.springfox

springfox-swagger2

2.6.1

io.springfox

springfox-swagger-ui

2.6.1

二、进行配置


Springboot项目快速搭建Swagger2.0_第2张图片

代码如下:

@Configuration

@EnableSwagger2

public class SwaggerConfig {

@Bean

public Docket buildDocket() {

return new Docket(DocumentationType.SWAGGER_2).apiInfo(buildApiInf()) // .apiInfo(apiInfo())

.select().apis(RequestHandlerSelectors.basePackage("com.yq"))// 要注释的接口名

.paths(PathSelectors.any()).build();

}

private ApiInfo buildApiInf() {

return new ApiInfoBuilder().title("自己测试 API").termsOfServiceUrl("http://wapp.ncyunqi.com").version("1.0.0")

.build();

}

}


三、在启动项进行配置注解@EnableSwagger2 表示开启Swagger


Springboot项目快速搭建Swagger2.0_第3张图片

四、打开访问页面


Springboot项目快速搭建Swagger2.0_第4张图片

你可能感兴趣的:(Springboot项目快速搭建Swagger2.0)