1.导入依赖
ps:注意4.0版本的依赖包换成了下面这个
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>4.3.0</version>
</dependency>
2.SpringBoot配置文件配置
springdoc:
swagger-ui:
path: /swagger-ui.html #Swagger-doc的路径
tags-sorter: alpha
operations-sorter: alpha
api-docs:
path: /v3/api-docs #json数据获取路径
group-configs:
- group: 'default' #分组名称
paths-to-match: '/**' #比如你要生成前缀是/user的,如localhost:8080/user/index,就需要配置这个
packages-to-scan: (换成你自己的controller包)
# knife4j的增强配置,不需要增强可以不配
knife4j:
enable: true #意思是开启Knife4j,这样就不需要添加@EnableSwagger2WebMvc注解了
setting:
language: zh_cn
3.官网的教程就是这样,但是打开localhost:8080/dot.html发现404错误,还需要下面的一个配置类。先起步,让接口文档能跑起来,你再去做个性化的配置以及高级功能的使用。
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class Knife4jConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info()
.title("接口文档")
.version("1.0")
.description("接口文档")
.termsOfService("localhost:8088/users")
);
}
}