依赖:
<!--swaggers2-->
<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>
配置文件:需要和启动类同一目录下。
package com.system.config;
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 SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.system.controller"))
.paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("myapp")
.termsOfServiceUrl("http://blog.csdn.net/java_yes")
.version("1.0").build();
}
}
controller:
@Api(tags = "StatisticController", description = "报表")
public class StatisticController {
@Autowired
private DeptService deptService;
@Autowired
private BuildService buildService;
@Autowired
private EventProcessService eventProcessService;
@Autowired
private StatisticService statisticService;
@Autowired
private CampusService campusService;
//工资统计报表
@ApiOperation(value="工资统计报表", notes="")
@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
@GetMapping(value = "getSalary")
@ResponseBody
public List<EchartCommonVo> getSalary(Integer campusid, Integer deptid){
Integer whweight=3;
Integer jbweight=7;
User loginuser= (User) SecurityUtils.getSubject().getSession().getAttribute("loginuser");
DateTimeFormatter df = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
LocalDateTime today=LocalDateTime.now();
LocalDateTime AMouthBefore = today.minusMonths(1);
LocalDateTime now = today.with(today);
String start = df.format(AMouthBefore);
String end=df.format(now);
User user= (User) SecurityUtils.getSubject().getSession().getAttribute("loginuser");
List<Dept> selectdepts=eventProcessService.getDeptBySelect(loginuser);
List<WorkLoadInfo> workLoadInfos=statisticService.getSalary(AMouthBefore,now,AMouthBefore,now,"1",whweight,jbweight,10);
List<EchartCommonVo> echartCommonVos=new ArrayList<EchartCommonVo>();
for(WorkLoadInfo vo:workLoadInfos){
EchartCommonVo evo=new EchartCommonVo(vo.getRealname(),vo.getResult().toString());
echartCommonVos.add(evo);
}
return echartCommonVos;
}
多参数:
@ApiImplicitParams({
@ApiImplicitParam(name = "file", value = "上传图片", required = true, dataType = "MultipartFile"),
@ApiImplicitParam(name = "location", value = "暂时不知道什么用", required = true, dataType = "Integer")
})
实体类:(实体类即使没有写注解,显示都一样,所以暂时不知道有什么用)
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
@ApiModel(value = "用户实体类")
public class User {
@ApiModelProperty(value = "用户唯一标识")
private Long id;
@ApiModelProperty(value = "用户姓名")
private String username;
@ApiModelProperty(value = "用户密码")
private String password;
// 省略set和get方法
}