1.Swagger介绍
Swagger是一个简单又强大的能为你的Restful风格的Api生成文档工具。在项目中集成这个工具，根据我们自己的配置信息能够自动为我们生成一个api文档展示页，可以在浏览器中直接访问查看项目中的接口信息，同时也可以测试每个api接口。Swagger生成的api文档是实时更新的，你写的api接口有任何的改动都会在文档中及时的表现出来。 Spring提供了一个与Swagger的集成工具包springfox，让我们的Spring项目能够更好的与Swagger融合。详情可访问springfox托管在Github上的demo内容。
2.SpringBoot2.0项目集成Swagger
引入Swagger依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-core-asl</artifactId>
<version>1.9.13</version>
</dependency>
引入Swagger配置文件
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* swagger配置文件
*
* @author QZB
* @create 2019-08-27-17:48
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("API接口文档") //这里写API文档标题
.description("HDFS目录/文件/用户权限管理") //这里写API文档描述
.version("1.0.0")
.build();
}
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.szewec.controller")) //这里写的是API接口所在的包位置
.paths(PathSelectors.any())
.build();
}
}
controller层添加相应的注解
@RestController
@RequestMapping("/api/hdfs/file")
@Api(value = "HDFS文件管理")
public class HDFSFileController {
private static Logger logger = LoggerFactory.getLogger(HDFSFileController.class);
@GetMapping(value = "/isExist")
@ApiOperation(value = "判断文件是否存在", notes = "判断文件是否存在")
@ApiImplicitParams({
@ApiImplicitParam(name = "fileName", value = "文件名称（包含文件路径）", paramType = "query", dataType = "string", required = true)
})
public Object isExist(String fileName) {
try {
if (StringUtils.isNotBlank(fileName)) {
return ResponseUtil.successObjectResponse(HDFSUtils.resourceIsExist(fileName));
} else {
return ResponseUtil.failedResponse("判断文件是否存在失败！", "文件名称为空！");
}
} catch (Exception e) {
logger.error("判断文件是否存在异常！", e);
return ResponseUtil.failedResponse("判断文件是否存在异常！", e.getMessage());
}
}
3. Swagger注解说明
