higress/plugins/wasm-go/extensions/request-validation/README.md

title, keywords, description

title	keywords	description
请求协议校验	higress request validation	请求协议校验插件配置参考

功能说明

request-validation插件用于提前验证向上游服务转发的请求。该插件使用JSON Schema机制进行数据验证，可以验证请求的body及header数据。

运行属性

插件执行阶段：认证阶段 插件执行优先级：220

配置字段

名称	数据类型	填写要求	默认值	描述
header_schema	object	选填	-	配置用于验证请求header的JSON Schema
body_schema	object	选填	-	配置用于验证请求body的JSON Schema
rejected_code	number	选填	403	配置请求被拒绝时返回的HTTP状态码
rejected_msg	string	选填	-	配置请求被拒绝时返回的HTTP应答Body
enable_swagger	bool	选填	false	配置是否开启swagger文档验证
enable_oas3	bool	选填	false	配置是否开启OAS3文档验证

校验规则对header和body是一样的，下面以body为例说明

配置示例

枚举（Enum）验证

body_schema:
  type: object
  required:
    - enum_payload
  properties:
    enum_payload:
      type: string
      enum:
        - "enum_string_1"
        - "enum_string_2"
      default: "enum_string_1"

布尔（Boolean）验证

body_schema:
  type: object
  required:
    - boolean_payload
  properties:
    boolean_payload:
      type: boolean
      default: true

数字范围（Number or Integer）验证

body_schema:
  type: object
  required:
    - integer_payload
  properties:
    integer_payload:
      type: integer
      minimum: 1
      maximum: 10

字符串长度（String）验证

body_schema:
  type: object
  required:
    - string_payload
  properties:
    string_payload:
      type: string
      minLength: 1
      maxLength: 10

正则表达式（Regex）验证

body_schema:
  type: object
  required:
    - regex_payload
  properties:
    regex_payload:
      type: string
      minLength: 1
      maxLength: 10
      pattern: "^[a-zA-Z0-9_]+$"

数组（Array）验证

body_schema:
  type: object
  required:
    - array_payload
  properties:
    array_payload:
      type: array
      minItems: 1
      items:
        type: integer
        minimum: 1
        maximum: 10
      uniqueItems: true
      default: [1, 2, 3]

多字段组合（Combined）验证

body_schema:
  type: object
  required:
    - boolean_payload
    - array_payload
    - regex_payload
  properties:
    boolean_payload:
      type: boolean
    array_payload:
      type: array
      minItems: 1
      items:
          type: integer
          minimum: 1
          maximum: 10
      uniqueItems: true
      default: [1, 2, 3]
    regex_payload:
      type: string
      minLength: 1
      maxLength: 10
      pattern: "^[a-zA-Z0-9_]+$"

自定义拒绝信息

body_schema:
  type: object
  required:
    - boolean_payload
  properties:
    boolean_payload:
      type: boolean
rejected_code: 403
rejected_msg: "请求被拒绝"