SOAP | APISIX & API7 API Gateway Docs

Static Configurations

The SOAP proxy endpoint and timeout are gateway-level settings. Configure an endpoint that every gateway instance can reach, then reload or roll out the gateway so the static configuration takes effect.

Add the SOAP proxy address to the persistent config.yaml used by the gateway deployment. The following endpoint matches the Docker setup in the example:

config.yaml

plugin_attr:
  soap:
    endpoint: http://soap-proxy:5000
    timeout: 3000

Reload the gateway after updating its configuration source:

apisix reload

Add the sidecar and plugin attributes to the complete, source-controlled values file used by the API7 Gateway release:

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

Set the release details, including the chart version already used by the deployment:

export GATEWAY_RELEASE=replace-with-gateway-release-name
export GATEWAY_NAMESPACE=replace-with-gateway-namespace
export GATEWAY_CHART_VERSION=replace-with-installed-chart-version

Apply the complete values file without changing the chart version:

helm upgrade "$GATEWAY_RELEASE" api7/gateway \
  --namespace "$GATEWAY_NAMESPACE" \
  --version "$GATEWAY_CHART_VERSION" \
  -f values.yaml

Parameters

See plugin common configurations for configuration options available to all plugins.

wsdl_url
string
required
URL of the WSDL document that defines the SOAP operations and upstream service endpoint.
max_req_body_size
integer
default: 67108864
vaild vaule:
greater than or equal to 1
Maximum request body size, in bytes, that the plugin buffers in memory. A larger body is rejected with HTTP 400 before SOAP conversion. Introduced in API7 Enterprise 3.9.17 and 3.10.4.
keepalive
object
Connection reuse settings for requests from the gateway to the SOAP proxy. If omitted, the plugin enables keepalive with a 50-second idle timeout and a pool size of 10.
- enable
  boolean
  default: true
  Whether to reuse connections to the SOAP proxy. Current released runtimes always enable reuse, so setting this field to false has no effect.
- timeout
  integer
  default: 30
  vaild vaule:
  greater than or equal to 10
  Maximum idle time, in seconds, for a reusable connection when keepalive is configured.
- pool
  integer
  default: 30
  vaild vaule:
  greater than or equal to 5
  Maximum number of reusable SOAP proxy connections retained by each worker when keepalive is configured.