添加依赖
注意版本，选取swagger-ui。jar包下有swagger-ui.html的
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
添加swagger配置文件
package com.chinamobile.itas.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(apiInfo())
.select()
//apis() 控制哪些接口暴露给swagger，
// RequestHandlerSelectors.any() 所有都暴露
// RequestHandlerSelectors.basePackage("com.info.*") 指定包位置
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("智慧交通评价分析系统")
.description("接口描述")
//联系人实体类
//.contact(new Contact("名字", "网址", "邮箱"))
//版本号
.version("1.0.0-SNAPSHOT")
.build();
}
}
测试
package com.chinamobile.itas.controller;
import com.chinamobile.itas.entity.SysDept;
import com.chinamobile.itas.service.SysDeptService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* <p>
* 部门管理 前端控制器
* </p>
*
* @author admin
* @since 2020-07-20
*/
@Controller
@RequestMapping("/sys-dept")
@Api(value = "SysDeptController", description = "SysDeptController")
public class SysDeptController {
@Autowired
private SysDeptService sysDeptService;
@GetMapping("/test")
@ApiOperation(notes = "测试", value = "test")
@ResponseBody
@ApiResponses({
@ApiResponse(code = 200, message = "成功"),
@ApiResponse(code = 500, message = "失败")
})
public SysDept test(){
return sysDeptService.queryAll();
}
}
