<!-- Knife4j Swagger 增強(qiáng)版依賴 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>4.5.0</version>
</dependency>
<!-- 若使用SpringBoot 3.x，需替換為以下依賴（適配Jakarta EE） -->
<!-- <dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>4.5.0</version>
    <exclusions>
        <exclusion>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
        </exclusion>
    </exclusions>
</dependency> -->

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
 * Knife4j/Swagger 配置類
 */
@Configuration
@EnableOpenApi // 開啟Swagger文檔（SpringBoot 3.x無需額外添加，2.x需添加）
public class SwaggerConfig {
    /**
     * 配置Docket實(shí)例，指定接口文檔的基本信息和掃描規(guī)則
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30) // OAS_30對(duì)應(yīng)Swagger3.0規(guī)范，推薦使用
                .apiInfo(apiInfo()) // 配置文檔基礎(chǔ)信息
                .select()
                // 掃描指定包下的接口（替換為你的接口所在包路徑）
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                // 掃描所有接口（不推薦，建議指定包）
                // .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any()) // 匹配所有接口路徑
                .build();
    }
    /**
     * 配置文檔的基礎(chǔ)信息（標(biāo)題、作者、版本、描述等）
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot + Knife4j/Swagger 接口文檔") // 文檔標(biāo)題
                .description("本文檔用于前后端聯(lián)調(diào)，自動(dòng)生成接口信息，無需手寫") // 文檔描述
                .contact(new Contact("開發(fā)者", "https://blog.csdn.net", "xxx@163.com")) // 作者信息（姓名、博客地址、郵箱）
                .version("1.0.0") // 文檔版本
                .build();
    }
}

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
/**
 * 用戶實(shí)體類
 */
@Data
@ApiModel(value = "User", description = "用戶實(shí)體")
public class User {
    @ApiModelProperty(value = "用戶ID", example = "1", required = false)
    private Long id;
    @ApiModelProperty(value = "用戶名", example = "zhangsan", required = true)
    private String username;
    @ApiModelProperty(value = "用戶密碼", example = "123456", required = true)
    private String password;
    @ApiModelProperty(value = "用戶年齡", example = "20", required = false)
    private Integer age;
}

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;
/**
 * 用戶管理接口
 */
@RestController
@RequestMapping("/user")
@Api(tags = "用戶管理接口", description = "提供用戶的增刪改查操作")
public class UserController {
    // 模擬數(shù)據(jù)庫數(shù)據(jù)
    private static final List<User> userList = new ArrayList<>();
    static {
        userList.add(new User(1L, "zhangsan", "123456", 20));
        userList.add(new User(2L, "lisi", "654321", 22));
    }
    /**
     * 查詢所有用戶
     */
    @GetMapping("/list")
    @ApiOperation(value = "查詢用戶列表", notes = "獲取所有用戶的詳細(xì)信息")
    public List<User> getUserList() {
        return userList;
    }
    /**
     * 根據(jù)ID查詢用戶
     */
    @GetMapping("/{id}")
    @ApiOperation(value = "根據(jù)ID查詢用戶", notes = "傳入用戶ID，獲取單個(gè)用戶信息")
    public User getUserById(@ApiParam(value = "用戶ID", required = true, example = "1") @PathVariable Long id) {
        return userList.stream().filter(user -> user.getId().equals(id)).findFirst().orElse(null);
    }
    /**
     * 添加用戶
     */
    @PostMapping("/add")
    @ApiOperation(value = "添加用戶", notes = "傳入用戶信息，新增用戶")
    public String addUser(@ApiParam(value = "用戶信息", required = true) @RequestBody User user) {
        userList.add(user);
        return "添加成功";
    }
    /**
     * 修改用戶
     */
    @PutMapping("/update")
    @ApiOperation(value = "修改用戶", notes = "傳入用戶ID和新信息，修改用戶")
    public String updateUser(@ApiParam(value = "用戶信息", required = true) @RequestBody User user) {
        userList.replaceAll(u -> u.getId().equals(user.getId()) ? user : u);
        return "修改成功";
    }
    /**
     * 刪除用戶
     */
    @DeleteMapping("/{id}")
    @ApiOperation(value = "刪除用戶", notes = "傳入用戶ID，刪除指定用戶")
    public String deleteUser(@ApiParam(value = "用戶ID", required = true, example = "1") @PathVariable Long id) {
        userList.removeIf(user -> user.getId().equals(id));
        return "刪除成功";
    }
}

http://localhost:8080/doc.html

// 在SwaggerConfig的createRestApi方法中添加
.addGlobalParameters(Collections.singletonList(
        new ParameterBuilder()
                .name("Authorization") // 參數(shù)名
                .description("令牌（格式：Bearer token）") // 參數(shù)描述
                .in(ParameterType.HEADER) // 參數(shù)位置（HEADER/QUERY/PATH）
                .required(false) // 是否必填（根據(jù)項(xiàng)目需求調(diào)整）
                .schema(new Schema<String>().type("string"))
                .build()
))

// 排除/login和/error接口
.paths(PathSelectors.regex("^(?!/login|/error).*$"))

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

# application-dev.yml（開發(fā)環(huán)境，開啟）
knife4j:
  enable: true
# application-prod.yml（生產(chǎn)環(huán)境，關(guān)閉）
knife4j:
  enable: false

@Configuration
@EnableOpenApi
@ConditionalOnProperty(prefix = "knife4j", name = "enable", havingValue = "true")
public class SwaggerConfig {
    // 配置內(nèi)容不變
}