Go项目中OpenAPI Generator实现int64范围验证问题

核心问题说明 #

OpenAPI Generator默认生成的AssertXXRequired系列方法只做必填项校验，不会自动生成数值范围（min/max）的验证逻辑——这就是你在controller-api.mustache里找不到相关代码的原因，得通过调整模板或引入验证库来实现需求。

具体解决办法 #

办法1：修改模板手动添加验证逻辑 #

1. 找到你使用的controller-api.mustache模板文件：如果是用内置模板，路径大概是modules/openapi-generator/src/main/resources/go/controller-api.mustache；如果是项目自定义模板，就在你指定的模板文件夹内。
2. 在AssertPetRequired这类必填校验方法中，给amount字段添加范围判断代码，示例如下：

if body.Amount != nil {
    if *body.Amount < 100 || *body.Amount > 100000 {
        return errors.New("amount必须在100到100000之间")
    }
}

3. 重新运行OpenAPI Generator生成代码，新的控制器方法就会包含这个自定义验证逻辑。

办法2：引入Go验证库实现自动校验 #

1. 先安装常用的验证库：

go get github.com/go-playground/validator/v10

2. 在OpenAPI YAML的amount字段定义中添加扩展字段，指定验证规则：

amount:
  type: integer
  format: int64
  minimum: 100
  maximum: 100000
  x-go-validator: "gte=100,lte=100000"

3. 要么修改模型模板让生成的结构体自动带上validator标签，要么手动给Amount字段添加标签：

type Pet struct {
    Amount *int64 `json:"amount,omitempty" validate:"gte=100,lte=100000"`
    // 其他字段...
}

4. 在控制器的必填校验逻辑之后，添加验证执行代码：

validate := validator.New()
if err := validate.Struct(body); err != nil {
    return err
}

这样就能自动触发数值范围的校验。

顺便检查YAML配置正确性 #

确保你的OpenAPI YAML格式无误，正确的范围配置示例如下：

components:
  schemas:
    Pet:
      type: object
      properties:
        amount:
          type: integer
          format: int64
          minimum: 100
          maximum: 100000
          exclusiveMinimum: false # 可选，默认false，包含最小值
          exclusiveMaximum: false # 可选，默认false，包含最大值
      required:
        - amount # 如果是必填字段则添加

注意：即便YAML配置完全正确，OpenAPI Generator默认也不会生成范围校验逻辑，仍需结合上述两种办法实现需求。

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