SpringFox迁移至SpringDoc：@Parameter如何替代dataType与paramType参数

核心替换规则 #

• paramType 替换为 in 属性：用 ParameterIn 枚举指定参数位置（类型更安全），比如请求头就用 ParameterIn.HEADER
• dataType 替换为 schema 属性：通过 @Schema 注解明确参数类型，或者省略让SpringDoc自动推断

代码示例对比 #

原SpringFox注解：

@ApiImplicitParam(value = "token", required = true, dataType = "string",
      paramType = "header")

迁移后的SpringDoc注解：

@Parameter(value = "token", required = true, in = ParameterIn.HEADER,
      schema = @Schema(type = "string"))

额外说明 #

1. 如果参数是Java原生类型（比如String），schema 可以直接省略，SpringDoc会自动根据上下文推断类型
2. ParameterIn 枚举包含所有常见参数位置：HEADER、QUERY、PATH、BODY 等，避免手写字符串出错
3. 需要引入对应依赖包：org.springdoc.core.annotations.Parameter、io.swagger.v3.oas.annotations.enums.ParameterIn、io.swagger.v3.oas.annotations.media.Schema

内容的提问来源于stack exchange，提问作者Peter Penzov