在 Swagger 中生成代码时如何使用 useBeanValidation 选项？

Question

Swagger 的 Spring 服务器代码生成有一个名为 useBeanValidation 的选项，但我不知道如何使用它。我找不到任何文档告诉我它支持哪些验证，所以我决定自己尝试一下。 OpenAPI 规范对模式对象属性的描述列出了这些属性：

title
multipleOf
maximum
exclusiveMaximum
minimum
exclusiveMinimum
maxLength
minLength
pattern
maxItems
minItems
uniqueItems
maxProperties
minProperties
required
enum

所以我尝试将其中一些属性添加到我创建的对象的字段中。这是我的 .yaml 文件的相关部分：

components:
  schemas:
    Dummy:
      type: object
      properties:
        iMinMax:
          type: integer
          format: int32
          minimum: 0
          maximum: 100
        dMinMaxEx:
          type: number
          format: int32
          minimum: 5.0
          maximum: 10.0
          exclusiveMinimum: false
          exclusiveMaximum: true
        dMinExMaxEx:
          type: number
          format: int32
          minimum: 5.0
          maximum: 10.0
          exclusiveMinimum: true
          exclusiveMaximum: true
        dMinExMax:
          type: number
          format: int32
          minimum: 5.0
          maximum: 10.0
          exclusiveMinimum: true
          exclusiveMaximum: false
        sArray:
          type: array
          items:
            type: string
          minItems: 5
          maxItems: 10
          uniqueItems: true
        sLen:
          type: string
          format: text
          minLength: 5
          maxLength: 10

我打开了Spring代码生成器的bean验证选项，生成了服务端代码，但是没有任何效果。它生成的代码与关闭选项时完全相同。有谁知道如何使用 Swagger 的 Bean Validation 选项？

Answer 1

在最新版本的生成器（我上次检查的是 3.3.4）中有 2 个属性会影响 bean 验证。这些属性是performBeanValidation 和useBeanValidation（都是false by default）。要了解它们是如何工作的，您应该查看生成器结合生成器属性使用的 mustache 模板。这些可以在JavaSpring Mustache files 中找到。

例如，如果您的 API yaml 包含使用 format: email 定义的属性，您将看到带有和不带有 performBeanValidation 的不同行为。使用performBeanValidation=true，生成器输出@Email 验证注释。使用performBeanValidation=false，您将看不到此注释。这可以通过查看以下胡子文件来理解：beanValidationCore

您可以通过将原始 Mustache 文件从源位置复制到您自己的项目位置并根据需要进行修改来覆盖任何这些 Mustache 模板。然后，您将项目位置作为参数或属性提供给生成器。例如templateDirectory=src/main/resources/mustache

块引用

        <plugin>
            <groupId>org.openapitools</groupId>
            <artifactId>openapi-generator-maven-plugin</artifactId>
            <version>${openapi-codegen-version}</version>
            <executions>
                <execution>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                    <configuration>
                        <inputSpec>api.yaml</inputSpec>
                        <output>target/generated-sources</output>
                        <apiPackage>my.package.api</apiPackage>
                        <modelPackage>my.package.api.model</modelPackage>
                        <generatorName>spring</generatorName>
                        <templateDirectory>src/main/resources/mustache</templateDirectory>
                        <!--<configHelp>true</configHelp>-->
                        <!--<verbose>true</verbose>-->
                        <configOptions>
                            <dateLibrary>java8-localdatetime</dateLibrary>
                            <java8>false</java8>
                            <interfaceOnly>true</interfaceOnly>
                            <performBeanValidation>true</performBeanValidation>
                            <useBeanValidation>true</useBeanValidation>
                        </configOptions>
                    </configuration>
                </execution>
            </executions>
        </plugin>