新项目需要使用到swagger生成一些项目的接口信息,便于前端查看调试,所以这次采用了knife4j来作为项目的接口生成工具,顺便记录下使用笔记。
地址:https://doc.xiaominfo.com/knife4j/action/springboot.html
提示:
2.2.x
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.9</version>
</dependency>
<!-- https://mvnrepository.com/artifact/javax.validation/validation-api -->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
@Configuration//配置类
@EnableSwagger2 //swagger注解
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class) //knife4j需要引入
public class SwaggerConfig {
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("接口api工具")
.description("系统接口API工具")
.version("1.0") //版本
.license("xxxx")//所有者
.build();//构造
}
@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
//分组名称
.groupName("2.X版本")
.select()
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("com.tx.base.primary.controller"))
.paths(PathSelectors.any())
.build();
return docket;
}
}
访问地址:http://127.0.0.1:8080/doc.html#/home
完!
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。