使用Swagger 2.0生成启用Bean Validation的代码失败，求解决方法

我之前在项目里也折腾过这个问题，终于找到一套靠谱的流程，不管你用Swagger Codegen CLI还是Maven插件，都能顺利生成带Bean Validation支持的代码。下面一步步来：

首先得在你的Swagger YAML/JSON里定义好字段的校验规则，Swagger的原生关键字会自动映射到Bean Validation注解。举个实际的模型例子：

definitions:
  User:
    type: object
    # 必填字段会自动生成@NotNull注解
    required:
      - username
      - email
    properties:
      username:
        type: string
        minLength: 3
        maxLength: 20
        description: 用户名长度必须在3-20之间
      email:
        type: string
        format: email
        description: 必须是合法的邮箱格式
      age:
        type: integer
        minimum: 18
        maximum: 100
        description: 年龄必须在18到100之间

对应的核心映射关系：

• required: true → @NotNull
• minLength/maxLength → @Size(min=..., max=...)
• minimum/maximum → @Min(...)/@Max(...)
• format: email → @Email
• format: url → @URL

接下来要告诉Codegen生成代码时把这些约束转换成Bean Validation注解，分两种常用场景：

用Swagger Codegen CLI的情况 #

直接在生成命令里加上--enable-bean-validation参数就行，比如生成Java Spring代码的命令：

java -jar swagger-codegen-cli-2.4.28.jar generate \
  -i path/to/your/swagger.yaml \
  -l spring \
  -o generated-code-dir \
  --enable-bean-validation

注意：确保你的CLI版本在2.3.0及以上，旧版本可能没有这个参数。

用Maven插件的情况 #

在pom.xml的swagger-codegen插件配置里添加<enableBeanValidation>true</enableBeanValidation>：

<plugin>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-codegen-maven-plugin</artifactId>
  <version>2.4.28</version>
  <executions>
    <execution>
      <goals>
        <goal>generate</goal>
      </goals>
      <configuration>
        <inputSpec>${project.basedir}/src/main/resources/swagger.yaml</inputSpec>
        <language>spring</language>
        <output>${project.build.directory}/generated-sources/swagger</output>
        <!-- 关键配置：启用Bean Validation -->
        <enableBeanValidation>true</enableBeanValidation>
        <!-- 可选：自定义包路径 -->
        <apiPackage>com.example.api</apiPackage>
        <modelPackage>com.example.model</modelPackage>
      </configuration>
    </execution>
  </executions>
</plugin>

如果Swagger原生关键字满足不了你的需求（比如要加@Pattern正则校验），可以用Swagger的扩展字段x-annotations来手动指定注解。比如：

properties:
  phone:
    type: string
    x-annotations:
      - "@Pattern(regexp=\"^1[3-9]\\d{9}$\", message=\"手机号格式不正确\")"

生成代码后，这个字段就会带上你定义的@Pattern注解。

运行生成命令后，打开你的Model类（比如User.java），应该能看到类似这样的代码：

@ApiModel(description = "User model")
public class User {
  @JsonProperty("username")
  @NotNull(message = "username is required")
  @Size(min = 3, max = 20, message = "用户名长度必须在3-20之间")
  private String username;

  @JsonProperty("email")
  @NotNull(message = "email is required")
  @Email(message = "必须是合法的邮箱格式")
  private String email;

  @JsonProperty("age")
  @Min(18)
  @Max(100)
  private Integer age;

  // 自动生成的getter、setter方法
}

之后在Spring控制器里，只要给请求体参数加上@Valid注解，就能触发校验了：

@PostMapping("/users")
public ResponseEntity<User> createUser(@Valid @RequestBody User user) {
  // 业务逻辑处理
}

• 如果生成的代码里没有注解，先检查Codegen版本是否够新（至少2.3.0），再确认是否加了--enable-bean-validation参数或者Maven里的配置项。
• 某些语言模板对Bean Validation的支持有限，目前Java Spring的支持是最完善的，其他语言可能需要自定义模板。
• 如果用了x-annotations但没生效，要确认你的Codegen模板是否支持扩展字段，Spring模板是支持的。

内容的提问来源于stack exchange，提问作者Sonia Jain