update plugins doc (#1305)

This commit is contained in:
澄潭
2024-09-12 21:48:40 +08:00
committed by GitHub
parent 0f9113ed82
commit c7c4ae1da2
80 changed files with 7373 additions and 2368 deletions

View File

@@ -1,7 +1,18 @@
# 功能说明
---
title: 请求协议校验
keywords: [higress,request validation]
description: 请求协议校验插件配置参考
---
## 功能说明
`request-validation`插件用于提前验证向上游服务转发的请求。该插件使用`JSON Schema`机制进行数据验证可以验证请求的body及header数据。
# 配置字段
## 运行属性
插件执行阶段:`认证阶段`
插件执行优先级:`220`
## 配置字段
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
| -------- | -------- | -------- |-----| -------- |
@@ -14,9 +25,9 @@
**校验规则对header和body是一样的下面以body为例说明**
# 配置示例
## 配置示例
## 枚举Enum验证
### 枚举Enum验证
```yaml
body_schema:
type: object
@@ -31,7 +42,7 @@ body_schema:
default: "enum_string_1"
```
## 布尔Boolean验证
### 布尔Boolean验证
```yaml
body_schema:
type: object
@@ -43,7 +54,7 @@ body_schema:
default: true
```
## 数字范围Number or Integer验证
### 数字范围Number or Integer验证
```yaml
body_schema:
type: object
@@ -56,7 +67,7 @@ body_schema:
maximum: 10
```
## 字符串长度String验证
### 字符串长度String验证
```yaml
body_schema:
type: object
@@ -69,7 +80,7 @@ body_schema:
maxLength: 10
```
## 正则表达式Regex验证
### 正则表达式Regex验证
```yaml
body_schema:
type: object
@@ -83,7 +94,7 @@ body_schema:
pattern: "^[a-zA-Z0-9_]+$"
```
## 数组Array验证
### 数组Array验证
```yaml
body_schema:
type: object
@@ -101,7 +112,7 @@ body_schema:
default: [1, 2, 3]
```
## 多字段组合Combined验证
### 多字段组合Combined验证
```yaml
body_schema:
type: object
@@ -128,7 +139,7 @@ body_schema:
pattern: "^[a-zA-Z0-9_]+$"
```
## 自定义拒绝信息
### 自定义拒绝信息
```yaml
body_schema:
type: object
@@ -141,6 +152,3 @@ rejected_code: 403
rejected_msg: "请求被拒绝"
```
# 本地调试
参考[使用 GO 语言开发 WASM 插件](https://higress.io/zh-cn/docs/user/wasm-go#%E4%B8%89%E6%9C%AC%E5%9C%B0%E8%B0%83%E8%AF%95)