SpringFox的@ApiImplicitParam迁移springdoc时paramType等参数替换问题

算力阿峰

2026-7-16

SpringFox 转 SpringDoc：@ApiImplicitParam 替换为 @Parameter 的正确写法

先看修正后的可运行代码：

import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.media.Schema;

// ...

@Parameter(name = "Proxy", description = "Authorization value", required = true, in = ParameterIn.HEADER, schema = @Schema(type = "string"))
public .. endpoint(...){.....}

错误参数的替代方案：

原paramType = "header"：SpringDoc中用 in = ParameterIn.HEADER 指定参数位于请求头，ParameterIn 枚举还提供了QUERY、PATH、COOKIE等选项，对应原SpringFox的paramType各类取值。
原dataType = "string"：替换为 schema = @Schema(type = "string")，@Schema注解用于定义参数的类型元数据。实际开发中如果参数类型能被SpringDoc自动推断（比如字符串类型的请求头），可以省略schema属性，框架会自动识别类型。