Skip to main content
Version: Next

body-transformer

描述#

body-transformer 插件执行基于模板的转换,将请求和/或响应主体从一种格式转换为另一种格式,例如从 JSON 到 JSON、从 JSON 到 HTML 或从 XML 到 YAML。

属性#

名称类型必选项默认值有效值描述
requestobject请求体转换配置。
request.input_formatstring[xml,json,encoded,args,plain,multipart]请求体原始媒体类型。若未指定,则该值将由 Content-Type 标头确定以应用相应的解码器。xml 选项对应于 text/xml 媒体类型。json 选项对应于 application/json 媒体类型。encoded 选项对应于 application/x-www-form-urlencoded 媒体类型。args 选项对应于 GET 请求。plain 选项对应于 text/plain 媒体类型。multipart 选项对应于 multipart/related 媒体类型。如果媒体类型不是这两种类型,则该值将保留未设置状态并直接应用转换模板。
request.templatestringTrue请求体转换模板。模板使用 lua-resty-template 语法。有关更多详细信息,请参阅 模板语法。您还可以使用辅助函数 _escape_json()_escape_xml() 转义双引号等特殊字符,使用 _body 访问请求正文,使用 _ctx 访问上下文变量。
request.template_is_base64booleanfalse如果模板是 base64 编码的,则设置为 true。
responseobject响应体转换配置。
response.input_formatstring[xml,json]响应体原始媒体类型。如果未指定,则该值将由 Content-Type 标头确定以应用相应的解码器。如果媒体类型既不是 xml 也不是 json,则该值将保留未设置状态,并直接应用转换模板。
response.templatestringTrue响应主体转换模板。
response.template_is_base64booleanfalse如果模板是 base64 编码的,则设置为 true。

示例#

以下示例演示了如何针对不同场景配置 body-transformer

note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量:

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')

转换模板使用 lua-resty-template 语法。请参阅 模板语法 了解更多信息。

您还可以使用辅助函数 _escape_json()_escape_xml() 转义特殊字符(例如双引号)、_body 访问请求正文以及 _ctx 访问上下文变量。

在所有情况下,您都应确保转换模板是有效的 JSON 字符串。

JSON 和 XML SOAP 之间的转换#

以下示例演示了在使用 SOAP 上游服务时如何将请求主体从 JSON 转换为 XML,将响应主体从 XML 转换为 JSON。

启动示例 SOAP 服务:

cd /tmp
git clone https://github.com/spring-guides/gs-soap-service.git
cd gs-soap-service/complete
./mvnw spring-boot:run

创建请求和响应转换模板:

req_template=$(cat <<EOF | awk '{gsub(/"/,"\\\"");};1' | awk '{$1=$1};1' | tr -d '\r\n'
<?xml version="1.0"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
<soap-env:Body>
<ns0:getCountryRequest xmlns:ns0="http://spring.io/guides/gs-producing-web-service">
<ns0:name>{{_escape_xml(name)}}</ns0:name>
</ns0:getCountryRequest>
</soap-env:Body>
</soap-env:Envelope>
EOF
)

rsp_template=$(cat <<EOF | awk '{gsub(/"/,"\\\"");};1' | awk '{$1=$1};1' | tr -d '\r\n'
{% if Envelope.Body.Fault == nil then %}
{
"status":"{{_ctx.var.status}}",
"currency":"{{Envelope.Body.getCountryResponse.country.currency}}",
"population":{{Envelope.Body.getCountryResponse.country.population}},
"capital":"{{Envelope.Body.getCountryResponse.country.capital}}",
"name":"{{Envelope.Body.getCountryResponse.country.name}}"
}
{% else %}
{
"message":{*_escape_json(Envelope.Body.Fault.faultstring[1])*},
"code":"{{Envelope.Body.Fault.faultcode}}"
{% if Envelope.Body.Fault.faultactor ~= nil then %}
, "actor":"{{Envelope.Body.Fault.faultactor}}"
{% end %}
}
{% end %}
EOF
)

上面使用了 awktr 来操作模板,使模板成为有效的 JSON 字符串。

使用之前创建的模板创建带有 body-transformer 的路由。在插件中,将请求输入格式设置为 JSON,将响应输入格式设置为 XML,并将 Content-Type 标头设置为 text/xml,以便上游服务正确响应:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "body-transformer-route",
"methods": ["POST"],
"uri": "/ws",
"plugins": {
"body-transformer": {
"request": {
"template": "'"$req_template"'",
"input_format": "json"
},
"response": {
"template": "'"$rsp_template"'",
"input_format": "xml"
}
},
"proxy-rewrite": {
"headers": {
"set": {
"Content-Type": "text/xml"
}
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"localhost:8080": 1
}
}
}'
tip

如果将复杂的文本文件调整为有效的转换模板很麻烦,则可以使用 base64 实用程序对文件进行编码,例如以下内容:

"body-transformer": {
"request": {
"template": "'"$(base64 -w0 /path/to/request_template_file)"'"
},
"response": {
"template": "'"$(base64 -w0 /path/to/response_template_file)"'"
}
}

发送具有有效 JSON 主体的请求:

curl "http://127.0.0.1:9080/ws" -X POST -d '{"name": "Spain"}'

请求中发送的 JSON 主体将在转发到上游 SOAP 服务之前转换为 XML,响应主体将从 XML 转换回 JSON。

您应该会看到类似以下内容的响应:

{
"status": "200",
"currency": "EUR",
"population": 46704314,
"capital": "Madrid",
"name": "Spain"
}

修改请求体#

以下示例演示了如何动态修改请求体。

使用 body-transformer 创建一个路由,其中​​模板将单词 world 附加到 name,并将 10 添加到 age,以将它们分别设置为 foobar 的值:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "body-transformer-route",
"uri": "/anything",
"plugins": {
"body-transformer": {
"request": {
"template": "{\"foo\":\"{{name .. \" world\"}}\",\"bar\":{{age+10}}}"
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'

向路线发送请求:

curl "http://127.0.0.1:9080/anything" -X POST \
-H "Content-Type: application/json" \
-d '{"name":"hello","age":20}' \
-i

您应该看到以下响应:

{
"args": {},
"data": "{\"foo\":\"hello world\",\"bar\":30}",
...
"json": {
"bar": 30,
"foo": "hello world"
},
"method": "POST",
...
}

使用变量生成请求主体#

以下示例演示如何使用 ctx 上下文变量动态生成请求主体。

使用 body-transformer 创建路由,其中​​模板使用 Nginx 变量 arg_name 访问请求参数:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "body-transformer-route",
"uri": "/anything",
"plugins": {
"body-transformer": {
"request": {
"template": "{\"foo\":\"{{_ctx.var.arg_name .. \" world\"}}\"}"
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'

使用 name 参数向路由发送请求:

curl -i "http://127.0.0.1:9080/anything?name=hello"

您应该看到如下响应:

{
"args": {
"name": "hello"
},
...,
"json": {
"foo": "hello world"
},
...
}

将正文从 YAML 转换为 JSON#

以下示例演示如何将请求正文从 YAML 转换为 JSON。

创建请求转换模板:

req_template=$(cat <<EOF | awk '{gsub(/"/,"\\\"");};1'
{%
local yaml = require("tinyyaml")
local body = yaml.parse(_body)
%}
{"foobar":"{{body.foobar.foo .. " " .. body.foobar.bar}}"}
EOF
)

使用以下模板创建一个带有 body-transformer 的路由:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "body-transformer-route",
"uri": "/anything",
"plugins": {
"body-transformer": {
"request": {
"template": "'"$req_template"'"
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'

使用 YAML 主体向路由发送请求:

body='
foobar:
foo: hello
bar: world'

curl "http://127.0.0.1:9080/anything" -X POST \
-d "$body" \
-H "Content-Type: text/yaml" \
-i

您应该会看到类似以下内容的响应,这验证了 YAML 主体已适当地转换为 JSON:

{
"args": {},
"data": "{\"foobar\":\"hello world\"}",
...
"json": {
"foobar": "hello world"
},
...
}

将表单 URL 编码主体转换为 JSON#

以下示例演示如何将 form-urlencoded 主体转换为 JSON。

使用 body-transformer 创建路由,将 input_format 设置为 encoded,并配置一个模板,将字符串 world 附加到 name 输入,将 10 添加到 age 输入:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "body-transformer-route",
"uri": "/anything",
"plugins": {
"body-transformer": {
"request": {
"input_format": "encoded",
"template": "{\"foo\":\"{{name .. \" world\"}}\",\"bar\":{{age+10}}}"
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'

向路由发送一个带有编码主体的 POST 请求:

curl "http://127.0.0.1:9080/anything" -X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'name=hello&age=20'

您应该会看到类似以下内容的响应:

{
"args": {},
"data": "",
"files": {},
"form": {
"{\"foo\":\"hello world\",\"bar\":30}": ""
},
"headers": {
...
},
...
}

将 GET 请求查询参数转换为正文#

以下示例演示如何将 GET 请求查询参数转换为请求正文。请注意,这不会转换 HTTP 方法。要转换方法,请参阅 proxy-rewrite

使用 body-transformer 创建路由,将 input_format 设置为 args,并配置一个向请求添加消息的模板:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "body-transformer-route",
"uri": "/anything",
"plugins": {
"body-transformer": {
"request": {
"input_format": "args",
"template": "{\"message\": \"hello {{name}}\"}"
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'

向路线发送 GET 请求:

curl "http://127.0.0.1:9080/anything?name=john"

您应该会看到类似以下内容的响应:

{
"args": {},
"data": "{\"message\": \"hello john\"}",
"files": {},
"form": {},
"headers": {
...
},
"json": {
"message": "hello john"
},
"method": "GET",
...
}

转换纯文本媒体类型#

以下示例演示如何转换具有 plain 媒体类型的请求。

使用 body-transformer 创建路由,将 input_format 设置为 plain,并配置模板以从正文字符串中删除 not 和后续空格:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "body-transformer-route",
"uri": "/anything",
"plugins": {
"body-transformer": {
"request": {
"input_format": "plain",
"template": "{\"message\": \"{* string.gsub(_body, \"not \", \"\") *}\"}"
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'

向路由发送 POST 请求:

curl "http://127.0.0.1:9080/anything" -X POST \
-d 'not actually json' \
-i

您应该会看到类似以下内容的响应:

{
"args": {},
"data": "",
"files": {},
"form": {
"{\"message\": \"actually json\"}": ""
},
"headers": {
...
},
...
}

转换多部分媒体类型#

以下示例演示如何转换具有 multipart 媒体类型的请求。

创建一个请求转换模板,该模板根据请求正文中提供的 age 向正文添加 status

req_template=$(cat <<EOF | awk '{gsub(/"/,"\\\"");};1'
{%
local core = require 'apisix.core'
local cjson = require 'cjson'

if tonumber(context.age) > 18 then
context._multipart:set_simple("status", "adult")
else
context._multipart:set_simple("status", "minor")
end

local body = context._multipart:tostring()
%}{* body *}
EOF
)

创建一个带有 body-transformer 的路由,将 input_format 设置为 multipart,并使用之前创建的请求模板进行转换:

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "body-transformer-route",
"uri": "/anything",
"plugins": {
"body-transformer": {
"request": {
"input_format": "multipart",
"template": "'"$req_template"'"
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'

向路由发送多部分 POST 请求:

curl -X POST \
-F "name=john" \
-F "age=10" \
"http://127.0.0.1:9080/anything"

您应该会看到类似以下内容的响应:

{
"args": {},
"data": "",
"files": {},
"form": {
"age": "10",
"name": "john",
"status": "minor"
},
"headers": {
"Accept": "*/*",
"Content-Length": "361",
"Content-Type": "multipart/form-data; boundary=------------------------qtPjk4c8ZjmGOXNKzhqnOP",
...
},
...
}