1.添加swagger2依赖
2.8.0
io.springfox
springfox-swagger2
${swagger.version}
io.springfox
springfox-swagger-ui
${swagger.version}
com.github.xiaoymin
swagger-bootstrap-ui
1.9.0
io.springfox
springfox-swagger2
2.9.2
2.配置swagger2
@Configuration
public class Swagger2 {
@Value("${swagger.enable}")
private boolean enableSwagger;
@Bean
public Docket api() {
ParameterBuilder tokenPar = new ParameterBuilder();
List pars = new ArrayList();
tokenPar.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
pars.add(tokenPar.build());
return new Docket(documentationType.SWAGGER_2)
.apiInfo(apiInfo()).enable(enableSwagger)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build()
.globalOperationParameters(pars);
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("本地测试Demo")
.description("")
.termsOfServiceUrl("")
.version("1.0")
.build();
}
}
3.配置application.yml文件
swagger: enable: true
4.配置启动类
@EnableSwagger2
@EnableSwaggerBootstrapUI
@SpringBootApplication
@MapperScan("com.example.demo.*.mapper")
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
5.在controller层添加标签：@api
@RequestMapping("/hello")
@Api(value = "您好", tags = "测试")
@RestController
public class HelloController {
@GetMapping("sayHello")
public String hello(){
return "hello wangxue";
}
@GetMapping("insert")
public void insert(){
}
}
这个注解有两个参数：value、tags
-
tags：说明该类的作用，可以在UI界面上看到
-
value: 说明该类作用，但在UI界面上看不到
结果如下：
