OpenApi数组和嵌套对象验证

Question

我使用的是OpenApi规范，这是生成类的代码示例：

CreateUsersRequest:
      required:
        - userIds
      type: object
      properties:
        userIds:
          uniqueItems: true
          minItems: 1
          type: array
          items:
            type: string
            format: uuid

我想禁止发送以下请求：

{
  "userIds": [
    ""
  ]
}

{
  "userIds": [
    null
  ]
}

如果我使用了javax。验证它看起来像：

@NotNull 
private List<@NotEmpty UUID> userIds;

有什么方法可以使用api.yml文件做同样的事情吗？

Answer 1

如留档所示：

OpenAPI 3.0没有JSON模式中明确的null类型，但您可以使用null:true指定值可以是null。请注意，null不同于空字符串“”。

为了防止出现空字符串，可以提供模式regex。

请尝试以下方法：

CreateUsersRequest:
      required:
        - userIds
      type: object
      properties:
        userIds:
          uniqueItems: true
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
            nullable: false
            pattern: ^[a-z|\-]+$

请仔细测试代码，我意识到您使用了格式：uuid，所以我对格式和模式的组合不是绝对有信心。

如有必要，您可以尝试提供自己的uuid类型。例如：

Uuid:
    type: string
    pattern: '^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$'
    nullable: false

以及：

CreateUsersRequest:
      required:
        - userIds
      type: object
      properties:
        userIds:
          uniqueItems: true
          minItems: 1
          type: array
          items:
            $ref: "#/components/schemas/Uuid"