参数
请参阅 插件通用配置 了解所有插件可用的配置选项。
request
请求体转换配置。
input_format
有效值:
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/form-data媒体类型。如果媒体类型都不是,该值将保持未设置状态,直接应用转换模板。
template
请求体转换模板。该模板使用 lua-resty-template 语法。更多详情请参阅模板语法。
你还可以使用辅助函数
_escape_json()和_escape_xml()来转义特殊字符(如双引号),使用_body访问请求体,使用_ctx访问上下文变量。参阅示例了解更多。模板名称
_ctx、_body、_escape_json、_escape_xml和_multipart为保留名称;_escape_json()与_escape_xml()应作为函数调用。解码后的请求字段若使用这些名称,将被忽略,以防覆盖辅助对象。template_is_base64
如果模板是 Base64 编码的,请设置为 true。
response
响应体转换配置。
input_format
有效值:
xml、json、encoded、args、plain或multipart响应体原始媒体类型。如果未指定,值将由
Content-Type响应头决定,以应用相应的解码器。xml选项对应text/xml媒体类型。json选项对应application/json媒体类型。encoded选项对应application/x-www-form-urlencoded媒体类型。args选项主要用于请求查询参数,通常不适用于响应体。plain选项对应text/plain媒体类型。multipart选项对应multipart/form-data媒体类型。如果媒体类型不属于任何受支持的类型,该值将保持未设置状态,并直接应用转换模板。
template
响应体转换模板。
模板名称
_ctx、_body、_escape_json、_escape_xml和_multipart为保留名称;_escape_json()与_escape_xml()应作为函数调用。解码后的响应字段若使用这些名称,将被忽略,以防覆盖辅助对象。template_is_base64
如果模板是 Base64 编码的,请设置为 true。
max_req_body_size
有效值:
大于或等于 1
转换时读取的请求体最大字节数。超过该大小的请求体会以状态码
413被拒绝。自 API7 企业版 3.9.17 和 3.10.4 以及 APISIX 3.18.0 起引入。max_resp_body_size
有效值:
大于或等于 1
转换时缓冲的响应体最大字节数。超过该大小的响应会在转换前截断到此大小。跨越阈值的数据块会在执行限制前先进入缓冲,因此瞬时内存用量可能超过配置值。自 API7 企业版 3.9.17 和 3.10.4 以及 APISIX 3.18.0 起引入。