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

# 配置springdoc-openapi，用于文檔化和訪問API
springdoc:
  # 配置Swagger UI的訪問路徑和排序方式
  swagger-ui:
    path: /swagger-ui.html  # Swagger UI的訪問路徑
    tags-sorter: alpha      # 按字母順序排序標(biāo)簽
    operations-sorter: alpha  # 按字母順序排序操作
  # 配置API文檔的訪問路徑
  api-docs:
    path: /v3/api-docs  # API文檔的訪問路徑
  # 配置API分組，用于組織和管理API
  group-configs:
    - group: 'default'   # API分組名稱
      paths-to-match: '/**'  # 匹配所有路徑
      packages-to-scan: com.ykx.easyexceldemo02.controller  # 掃描的包，用于自動(dòng)發(fā)現(xiàn)API
# knife4j的增強(qiáng)配置，不需要增強(qiáng)可以不配（詳細(xì)版見下小節(jié)）
knife4j:
  enable: true
  setting:
    language: zh_cn

# 配置Knife4j，以啟用Swagger文檔的增強(qiáng)功能和定制化展示
knife4j:
  # 啟用Knife4j擴(kuò)展
  enable: true
  # 配置展示的文檔分組
  documents:
    - 
      # 文檔分組標(biāo)題
      group: 2.X版本
      # 文檔分組描述
      name: 接口簽名
      # 指定接口文檔的位置
      locations: classpath:sign/*
  # 配置Knife4j的展示細(xì)節(jié)和功能開關(guān)
  setting:
    # 設(shè)置界面語言
    language: zh-CN
    # 啟用Swagger模型展示
    enable-swagger-models: true
    # 啟用文檔管理功能
    enable-document-manage: true
    # 設(shè)置Swagger模型的顯示名稱
    swagger-model-name: 實(shí)體類列表
    # 是否顯示版本信息
    enable-version: false
    # 是否啟用參數(shù)緩存刷新
    enable-reload-cache-parameter: false
    # 啟用后端腳本支持
    enable-after-script: true
    # 過濾特定方法類型的multipart/form-data接口
    enable-filter-multipart-api-method-type: POST
    # 是否過濾所有multipart/form-data類型的接口
    enable-filter-multipart-apis: false
    # 啟用請求緩存
    enable-request-cache: true
    # 是否顯示自定義主機(jī)名
    enable-host: false
    # 設(shè)置自定義的主機(jī)名
    enable-host-text: 192.168.0.193:8000
    # 啟用自定義首頁
    enable-home-custom: true
    # 設(shè)置自定義首頁的路徑
    home-custom-path: classpath:markdown/home.md
    # 是否啟用搜索功能
    enable-search: false
    # 是否顯示頁腳
    enable-footer: false
    # 啟用自定義頁腳內(nèi)容
    enable-footer-custom: true
    # 設(shè)置自定義頁腳的內(nèi)容
    footer-custom-content: Apache License 2.0 | Copyright 2019-[浙江八一菜刀股份有限公司](https://gitee.com/xiaoym/knife4j)
    # 是否啟用動(dòng)態(tài)參數(shù)
    enable-dynamic-parameter: false
    # 啟用調(diào)試模式
    enable-debug: true
    # 啟用OpenAPI 3.0的支持
    enable-open-api: false
    # 啟用接口分組功能
    enable-group: true
  # 是否啟用CORS跨域支持
  cors: false
  # 是否啟用生產(chǎn)模式
  production: false
  # 配置基本的認(rèn)證信息
  basic:
    # 啟用基本認(rèn)證
    enable: false
    # 設(shè)置用戶名
    username: test
    # 設(shè)置密碼
    password: 12313

@Operation(summary = "獲取用戶列表", description = "返回所有用戶的列表")
@GetMapping("/users")
public List<User> getUsers() {
    // ...
}

@Tag(name = "用戶管理", description = "用戶相關(guān)操作")
@RestController
@RequestMapping("/users")
public class UserController {
    // ...
}

@Operation(summary = "獲取用戶列表", description = "返回所有用戶的列表")
@GetMapping("/users")
public List<User> getUsers() {
    // ...
}

@Operation(summary = "獲取用戶列表")
@ApiResponses(value = {
    @ApiResponse(responseCode = "200", description = "成功", content = @Content(mediaType = "application/json", schema = @Schema(implementation = User.class))),
    @ApiResponse(responseCode = "400", description = "請求參數(shù)錯(cuò)誤"),
    @ApiResponse(responseCode = "404", description = "找不到資源"),
    @ApiResponse(responseCode = "500", description = "服務(wù)器內(nèi)部錯(cuò)誤")
})
@GetMapping("/users")
public List<User> getUsers() {
    // ...
}

@Operation(summary = "獲取用戶詳情")
@GetMapping("/{id}")
public User getUser(@Parameter(description = "用戶ID", required = true) @PathVariable Long id) {
    // ...
}

@Operation(summary = "分頁獲取用戶列表")
@Parameters({
    @Parameter(name = "page", description = "頁碼", required = true, schema = @Schema(type = "integer", example = "1")),
    @Parameter(name = "size", description = "每頁數(shù)量", required = true, schema = @Schema(type = "integer", example = "10"))
})
@GetMapping("/users")
public List<User> getUsersByPage(@RequestParam int page, @RequestParam int size) {
    // ...
}

@Schema(description = "用戶實(shí)體")
public class User {
    @Schema(description = "用戶ID", example = "1")
    private Long id;
    @Schema(description = "用戶名", example = "Alice")
    private String name;
    @Schema(description = "用戶年齡", example = "30")
    private Integer age;
    // getters and setters
}

@Schema(description = "用戶列表")
public class UserListResponse {
    @ArraySchema(schema = @Schema(implementation = User.class), description = "用戶數(shù)組")
    private List<User> users;
    // getters and setters
}

@Operation(summary = "上傳文件")
@PostMapping(value = "/upload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public String uploadFile(@Parameter(description = "文件", required = true) @RequestParam("file") MultipartFile file) {
    // ...
}