依赖
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
</dependency>
config配置文件
@Configuration
public class Knife4jConfig {@Beanpublic OpenAPI springShopOpenAPI() {return new OpenAPI().info(new Info().title("一个API接口文档").description("这是基于Knife4j OpenApi3的测试接口文档").version("1.0版本").contact(new Contact().name("戴中良").email("9533511@qq.com"))).externalDocs(new ExternalDocumentation().description("SpringBoot3测试knife4j").url("http://127.0.0.1:8888"));}
}
常用注解
package com.nnutc.model.entity;import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import java.time.LocalDateTime;
import java.io.Serializable;import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@Tag(name="角色",description = "角色实体类")
public class SysRole implements Serializable {private static final long serialVersionUID = 1L;@Schema(name="角色id",type = "long")@TableId(value = "id", type = IdType.AUTO)private Long id;private String roleName;private String roleCode;private String description;private LocalDateTime createTime;private LocalDateTime updateTime;@Schema(description = "0: 表示一种状态, 1: 表示另一种状态", allowableValues = "0, 1")private Integer isDeleted;
}