# SOAP 配置选项

soap 插件将 JSON 请求转换为 WSDL 定义的 SOAP 操作，并将上游 SOAP 响应以 JSON 格式返回。<!-- --> <!-- -->配置涵盖静态设置和插件参数。

## 静态配置[​](#静态配置 "静态配置的直接链接")

SOAP Proxy 端点和超时属于网关级设置。请配置每个网关实例都可访问的端点，然后重新加载或滚动更新网关，使静态配置生效。

* 宿主机或 Docker
* Kubernetes (Helm)

将 SOAP Proxy 地址添加到网关部署使用的持久化 `config.yaml`。以下端点与[示例](https://docs.apiseven.com/hub/soap.md#%E9%85%8D%E7%BD%AE-soap-proxy)中的 Docker 配置一致：

config.yaml

```
plugin_attr:

  soap:

    endpoint: http://soap-proxy:5000

    timeout: 3000
```

更新配置源后重新加载网关：

```
apisix reload
```

将边车和插件属性添加到 API7 网关 Release 使用的完整、受版本控制的 values 文件：

values.yaml

```
soapProxy:

  enabled: true

  image:

    repository: api7/soap-proxy

    tag: 1.0.0

pluginAttrs:

  soap:

    endpoint: http://127.0.0.1:5000

    timeout: 3000
```

设置 Release 信息，包括部署当前使用的 Chart 版本：

```
export GATEWAY_RELEASE=replace-with-gateway-release-name

export GATEWAY_NAMESPACE=replace-with-gateway-namespace

export GATEWAY_CHART_VERSION=replace-with-installed-chart-version
```

应用完整的 values 文件，不更改 Chart 版本：

```
helm upgrade "$GATEWAY_RELEASE" api7/gateway \

  --namespace "$GATEWAY_NAMESPACE" \

  --version "$GATEWAY_CHART_VERSION" \

  -f values.yaml
```

## 参数[​](#参数 "参数的直接链接")

请参阅[通用配置](https://docs.apiseven.com/apisix/reference/plugin-common-configurations.md)了解所有插件可用的配置选项。

* wsdl\_url

  string

  必填

  ***

  定义 SOAP 操作和上游服务端点的 WSDL 文档 URL。

* max\_req\_body\_size

  integer

  默认值：`67108864`

  有效值：

  大于或等于 1

  ***

  插件缓冲到内存中的最大请求体大小（以字节为单位）。更大的请求体会在 SOAP 转换前以 HTTP 400 被拒绝。自 API7 企业版 3.9.17 和 3.10.4 起引入。

* keepalive

  object

  ***

  从网关到 SOAP Proxy 的请求连接复用设置。省略时，插件启用 keepalive，空闲超时为 50 秒，连接池大小为 10。

  * enable

    boolean

    默认值：`true`

    ***

    是否复用到 SOAP Proxy 的连接。当前已发布的运行时始终启用连接复用，因此将此字段设置为 `false` 不会生效。

  * timeout

    integer

    默认值：`30`

    有效值：

    大于或等于 10

    ***

    配置 `keepalive` 时，可复用连接的最大空闲时间（秒）。

  * pool

    integer

    默认值：`30`

    有效值：

    大于或等于 5

    ***

    配置 `keepalive` 时，每个 Worker 保留的可复用 SOAP Proxy 连接数上限。
