API接口开发框架 Swagger

1.添加maven jar

 

<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>

 

2.添加文件Swagger2.java 与spring boot的启动类在同一层

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;

@Configuration
@EnableSwagger2
public class Swagger2 {


@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("cn.com.threeInOneRoad.web"))
.paths(PathSelectors.any())
.build();
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("三合一项目 RESTful APIs")
.description("三合一项目后台api接口文档")
.version("1.0")
.build();
}

}

 

3.使用时添加注解

@Api(value="tDataCarController",description="车关联数据接口")
public class TDataCarController {

　　

@ApiOperation(value="查询电动车相关实时数据",notes="查询表",httpMethod="GET")
@RequestMapping(value="/getLast/{DEVICE_ID}",produces = "application/json;charset=UTF-8",method=RequestMethod.GET)
@ApiImplicitParams(
@ApiImplicitParam(name="DEVICE_ID",dataType="Long",paramType="PATH",required=true,value="设备ID")
)
public ResponseMessage getTDataCarLast(@PathVariable(value="DEVICE_ID")Long deviceId) {

}

}