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

# springdoc-openapi項(xiàng)目配置
springdoc:
  swagger-ui:
    #自定義swagger前端請(qǐng)求路徑,輸入http:localhost:8080/swagger-ui會(huì)自動(dòng)重定向到swagger頁(yè)面
    path: /swagger-ui
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs  #swagger后端請(qǐng)求地址
    enabled: true   #是否開啟文檔功能
  group-configs: #分組配置,可配置多個(gè)分組
    - group: 'default'             #分組名稱
      paths-to-match: '/**'        #配置需要匹配的路徑
      packages-to-scan: com.cms    #配置要掃描包的路徑,一般配置到啟動(dòng)類所在的包名
    - group: 'admin-api'
      paths-to-match: '/**'
      packages-to-scan: com.cms

# knife4j的增強(qiáng)配置，不需要增強(qiáng)可以不配
knife4j:
  enable: true    #開啟knife4j,無(wú)需添加@EnableKnife4j注解
  setting:
    language: zh_cn   #中文
    swagger-model-name: 實(shí)體列表   #默認(rèn)為：Swagger Models
  #開啟Swagger的Basic認(rèn)證功能,默認(rèn)是false,開啟后訪問(wèn)文檔頁(yè)面時(shí)會(huì)彈出用戶名和密碼輸入框
  basic:
    enable: true
    # Basic認(rèn)證用戶名
    username: user
    # Basic認(rèn)證密碼
    password: 123456

package com.cms.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * web層配置類,實(shí)現(xiàn)靜態(tài)資源映射，將knife4j相關(guān)資源放行，保證生成的接口文檔能夠正常進(jìn)行展示
 * @author Hva
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    /**
     * 設(shè)置靜態(tài)資源映射
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 添加靜態(tài)資源映射規(guī)則
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
        //配置 knife4j 的靜態(tài)資源請(qǐng)求映射地址
        registry.addResourceHandler("/doc.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

package com.cms.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Knife4j整合Swagger3 Api接口文檔配置類
 * @author Hva
 */
@Configuration
public class Knife4jConfig {

    /**
     * 創(chuàng)建了一個(gè)api接口的分組
     * 除了配置文件方式創(chuàng)建分組，也可以通過(guò)注冊(cè)bean創(chuàng)建分組
     */
    @Bean
    public GroupedOpenApi adminApi() { 
        return GroupedOpenApi.builder()
                // 分組名稱
                .group("app-api")
                // 接口請(qǐng)求路徑規(guī)則
                .pathsToMatch("/**")
                .build();
    }

    /**
     * 配置基本信息
     */
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                .info(new Info()
                        // 標(biāo)題
                        .title("Knife4j整合Swagger3 Api接口文檔")
                        // 描述Api接口文檔的基本信息
                        .description("Knife4j后端接口服務(wù)...")
                        // 版本
                        .version("v1.0.0")
                        // 設(shè)置OpenAPI文檔的聯(lián)系信息，姓名，郵箱。
                        .contact(new Contact().name("Hva").email("Hva@163.com"))
                        // 設(shè)置OpenAPI文檔的許可證信息，包括許可證名稱為"Apache 2.0"，許可證URL為"http://springdoc.org"。
                        .license(new License().name("Apache 2.0").url("http://springdoc.org"))
                );
    }
}

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>3.5.5</version>
</dependency>

package com.cms.entry;

import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

/**
 * @author Hva
 */
@Data
@TableName("user")
@Schema(description = "用戶登錄")
public class UserVO {
    
    @Schema(description = "用戶名")
    private String username;

    @Schema(description = "用戶密碼")
    private String password;

}

package com.cms.controller;

import com.cms.entry.UserVO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author: Hva
 * @Description: 用戶controller
 */
@RestController
@Tag(name = "用戶controller")
public class UserController {
    /**
     * 用戶列表
     */
    @Operation(summary = "登錄接口")
    @PostMapping("/login")
    public UserVO list(
            @RequestBody UserVO userVO
    ) {
       return userVO;
    }
}