1.添加依赖
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
2.添加配置类
package com.levi.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket=new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
//.title("swagger-bootstrap-ui-demo RESTful APIs")
.description("# swagger-bootstrap-ui-demo RESTful APIs")
.termsOfServiceUrl("http://www.xx.com/")
// .contact("xx@qq.com")
.version("1.0")
.build())
//分组名称
.groupName("2.X版本")
.select()
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("com.levi"))
.paths(PathSelectors.any())
.build();
return docket;
}
}
注意上面的包名要改成自己的controller包名
3.controller接口打上注解 @Api @ApiOperation
@Api(tags = "security-测试接口")
@RestController
//@RequestMapping("/security")
public class SecurityController {
@ApiOperation("r1")
@GetMapping("/r/r1")
public String r1() {
return "r1页面";
}
@ApiOperation("r2")
@GetMapping("/r/r2")
public String r2() {
return "r2页面";
}
@ApiOperation("登录成功跳转路径")
@PostMapping ("/loginSucess")
public String loginSucess() {
return "登陆成功";
}
}
4.运行项目 访问 ip:port/doc.html就可以了