<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.5.0</version> <!-- 官方穩(wěn)定版，兼容 Spring Boot 3.3.x:cite[2]:cite[8] -->
</dependency>

springdoc:
  swagger-ui:
    # 開(kāi)啟 swagger-ui 文檔展示
    enabled: true
    # UI訪問(wèn)路徑
    path: /swagger-ui.html
    # 標(biāo)簽排序方式
    tags-sorter: alpha
    # 操作排序方式
    operations-sorter: alpha
    # 保持認(rèn)證狀態(tài)
    persistAuthorization: true
    # 禁用示例接口
    disable-swagger-default-url: true
  api-docs:
    # 開(kāi)啟 OpenAPI 展示
    enabled: true
    # OpenAPI JSON路徑
    path: /v3/api-docs
  default-consumes-media-type: application/json
  default-produces-media-type: application/json
  cache:
    # 關(guān)閉文檔緩存
    disabled: false
  # 顯示actuator端點(diǎn)
  show-actuator: false
  # 推薦保持默認(rèn)，顯示結(jié)構(gòu)化參數(shù)
  # default-flat-param-object: true
  # 允許在文檔中展示 Spring MVC 的 ModelAndView 返回類型
  model-and-view-allowed: true
  # 推薦關(guān)閉以確保文檔精確性
  override-with-generic-response: false

@Configuration
@OpenAPIDefinition(
  info = @Info(title = "項(xiàng)目API文檔", version = "1.0", description = "SpringBoot接口文檔")
)
public class SpringDocConfig { 
  // 無(wú)需額外代碼
}

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

    @Operation(summary = "獲取用戶信息", description = "通過(guò)用戶id獲取用戶信息")
    @Parameters({
        @Parameter(in = ParameterIn.PATH, name = "id", description = "用戶uid", required = true)
    })
    @ApiResponse(responseCode = "404", description = "User not found")
    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id){
        // 實(shí)現(xiàn)代碼
        return new ResponseEntity(new User(10001,"feng","ADMIN"), HttpStatusCode.valueOf(200));
    }
    
    @Operation(summary = "獲取用戶列表-分頁(yè)")
    @GetMapping("/userPage.do")
    public BizResponse getUserPage(@ParameterObject UserPageForm form) {
        return BizResponse.ok(userServer.getUserPage(form));
    }
    
    @Operation(summary = "文件上傳")
    @PostMapping(name = "/upload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    public BizResponse<FileInfoVo> fileUpload(
            @Parameter(description = "文件",
                    content = @Content(mediaType = MediaType.MULTIPART_FORM_DATA_VALUE,
                            schema = @Schema(type = "string", format = "binary")))
            @RequestParam MultipartFile file) {
        FileInfo fileInfo = fileStorageService.of(file).setPath(uploadFilePath).upload();
        return BizResponse.ok(fileInfo);
    }
}

import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.media.Schema.RequiredMode;
import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.Size;

@data
public clas sUser{

    @Schema(description = "用戶ID", example = "1001")
    private Integer id;

    @Schema(description = "用戶名", example = "john_doe", requiredMode = RequiredMode.REQUIRED)
    @Size(min = 3, max = 20, message = "用戶名長(zhǎng)度必須在3到20個(gè)字符之間")
    private String username;
    
    @Schema(description = "用戶角色", allowableValues = {"ADMIN", "USER", "GUEST"})
    private String role;

    @Schema(description = "郵箱", example = "john_doe@mail.com")
    @Email
    private String email;
    
    @Schema(description = "最近登錄時(shí)間", example = "2025-07-15 12:25:32", type = "string")
    private Date lastLoginTime;
    
    @Schema(description = "出生年月日", example = "2025-07-15", type = "string")
    @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
    private Date birthDate;
}

@PostMapping(value = "/upload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
@Operation(summary = "上傳文件")
public ResponseEntity<String> uploadFile(
    @Parameter(
        description = "文件參數(shù)",
        required = true,
        content = @Content( // 關(guān)鍵：嵌套Content注解
            mediaType = MediaType.APPLICATION_OCTET_STREAM_VALUE,
            schema = @Schema(type = "string", format = "binary") // 明確格式
        )
    )
    @RequestParam("file") MultipartFile file) {
    // 業(yè)務(wù)邏輯
}

@Parameter(
    description = "多文件上傳",
    content = @Content(
        mediaType = MediaType.MULTIPART_FORM_DATA_VALUE,
        array = @ArraySchema( // 聲明數(shù)組類型
            schema = @Schema(type = "string", format = "binary")
        )
    )
)
@RequestParam("files") MultipartFile[] files

@RequestBody(
    description = "混合參數(shù)請(qǐng)求",
    content = @Content(
        mediaType = MediaType.MULTIPART_FORM_DATA_VALUE,
        encoding = {
            @Encoding(name = "file", contentType = "image/jpeg"), // 指定文件類型
            @Encoding(name = "remark", contentType = "text/plain") // 文本參數(shù)
        }
    )
)
@RequestPart("file") MultipartFile file,
@RequestPart("remark") String remark

@Bean
public GroupedOpenApi publicApi() {
    return GroupedOpenApi.builder()
        .group("公開(kāi)接口")
        .pathsToMatch("/api/public/**")
        .build();
}

@Bean
public GroupedOpenApi adminApi() {
    return GroupedOpenApi.builder()
        .group("管理接口")
        .pathsToMatch("/api/admin/**")
        .addOpenApiMethodFilter(method -> method.isAnnotationPresent(PreAuthorize.class))
        .build();
}

springdoc:
  swagger-ui:
    enabled: false   # 生產(chǎn)環(huán)境禁用 UI
  api-docs:
    enabled: false   # 禁用 OpenAPI 端點(diǎn):cite[1]