API网关请求验证程序是否支持格式属性？

Question

我在API Gateway swagger文件(OAS 3.0)中添加了一个请求验证器。当我通过传入一个无效的请求体来测试验证时，我收到的错误消息包括我不理解的错误。复制步骤如下。

1. 使用以下变量创建新的 api 网关：

openapi: 3.0.0
info:
  version: "1"
  title: Request Validation Example
  description: |
    ## Request Validation
    Minimal swagger to reproduce request validation errors.

x-amazon-apigateway-request-validators: 
  all:
    validateRequestBody: true
    validateRequestParameters: true
x-amazon-apigateway-gateway-responses:
  BAD_REQUEST_BODY:
    statusCode: 400
    responseTemplates:
      application/json: |
        {
          message: $context.error.messageString
          errors: $context.error.validationErrorString
        }
paths:
  /employee:
    post:
      x-amazon-apigateway-request-validator: all
      summary: Create a new Employee
      operationId: CreateEmployee
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Employee"
        required: true
      responses:
        "201":
          description: Created
          $ref: "#/components/responses/200"
components:
  responses:
    "200":
      description: Success
  schemas:
    Employee:
      type: object
      properties:
        id:
          type: integer
          format: int32
        phoneNumbers:
          type: array
          items:
            $ref: "#/components/schemas/PhoneNumber"
        salary:
          type: number
          format: double
      required:
        - phoneNumbers
        - salary      
    PhoneNumber:
      type: object
      properties:
        number:
          type: string
      required:
        - number

为新创建的员工资源设置集成方法，选择模拟集成。

使用以下请求正文测试员工发布方法:

{
    "id": 1,
    "phoneNumbers": [
        {
            "number": "1234567890"
        }
    ],
    "salary": 45000
}

此请求主体的请求验证将成功

{
    "id": "1",
    "phoneNumbers": [
        {
            "number": "1234567890"
        }
    ],
    "salary": 45000
}

您现在将看到以下请求验证错误：

{
  message:  "Invalid request body"
  errors: [instance type (string) does not match any allowed primitive type (allowed: [\"integer\"]), format attribute \"double\" not supported, format attribute \"int32\" not supported]
}

您可以看到此消息包含正确的错误，指出字符串id与整数类型不匹配。您还会看到格式属性Double和int32不支持的错误，这些是我不理解的错误。据我所知，OAS 2.0和3.0支持Double和int32格式属性。API网关请求验证器支持Double和int32格式属性吗？在我的swagger定义中，请求验证器配置不正确吗？

编辑：看来int32和双格式属性是已知问题：https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html#api-RESTAPI的网关已知问题

然而，我在format属性中使用正则表达式时也遇到了这些问题。这在已知问题中没有特别提到，所以仍在寻找这方面的信息。

Answer 1

我认为需要注意的是，OAS文档中定义的模型应该是JSONSchema，而不一定是OpenAPI。它们在运行时被验证为JSONSchema Draft 4，该规范中不包含< code>format属性。

有时令人困惑的是＜code＞导入＜code＞操作。当使用OpenAPI定义API并导入API时，API网关将解析模型OAS规范和JSONSchema草案4的交集。

如果您需要JSONSchema的属性，而该属性未包含在OpenAPI的Schema规范中（例如type：[…， null]），则直接创建或更新API网关::模型是一种解决方法。