springboot3-knife4j包实现接口文档

Java笔记

一言准备中...

1.导入包

<!--knife4j-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>4.4.0</version>
</dependency>

2.config目录下新增java类：SwaggerConfig，在类上加：@Configuratioon
@Bean
public OpenAPI customOpenAPI(){
return new OpenAPI()
.info(new Info()
.title("springboot3+vue3脚手架")
.version("1.0")
.description("springboot3+vue3脚手架接口文档")
.contact(new Contact().name("爱资源吧").url("www.azyb.cn")));
}

3.在application.yml配置文件中配置knife4j

#springbott knife4j配置
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: "default"
      paths-to-match: '/**'
      packages-to-scan: azyb_cn.controller
#knife4j增强配置
knife4j:
    enable: true
    setting:
      language: zh_cn
      swagger-model-name: 实体类列表
4.添加swagger注解
为controller类添加@Tag(name = "XXX接口")
controller方法上添加@Operation(summary = "添加管理员")
在实体类上添加：@Schema(description = "对应的信息")