SylviaBABY commented on code in PR #6886: URL: https://github.com/apache/apisix/pull/6886#discussion_r853649048
########## docs/zh/latest/plugins/batch-requests.md: ########## @@ -23,92 +28,107 @@ title: batch-requests ## 描述 -`batch-requests` 插件可以一次接受多个请求并以 [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式在网关发起多个 http 请求，合并结果后再返回客户端，这在客户端需要访问多个接口时可以显著地提升请求性能。 +`batch-requests` 插件可以一次接受多个请求并以 [HTTP pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式在网关发起多个 HTTP 请求，合并结果后再返回客户端。 -> **提示** -> -> 外层的 Http 请求头会自动设置到每一个独立请求中，如果独立请求中出现相同键值的请求头，那么只有独立请求的请求头会生效。 +在客户端需要访问多个 API 的情况下，这将显著提高性能。 + +:::note + +外部批处理请求的 HTTP 请求头（除了以 `Content-` 开始的请求头，例如：`Content-Type`）适用于**批处理**中的每个请求。 + +如果在外部请求和单个调用中都指定了相同的 HTTP 请求头，则单个调用的请求头优先。 + +::: ## 属性 无 ## 接口 -插件会增加 `/apisix/batch-requests` 这个接口，需要通过 [public-api](../../../en/latest/plugins/public-api.md) 插件来暴露它。 +该插件会增加 `/apisix/batch-requests` 接口。 -## 如何启用 +:::note -你需要在 `config.yaml` 里面启用 batch-requests 插件： +你需要通过 [public-api](../../../zh/latest/plugins/public-api.md) 插件来暴露它。 -``` -# 加到 config.yaml +::: + +## 启用插件 + +该插件默认是禁用状态，你可以配置文件（`./conf/config.yaml`）添加如下配置启用 `batch-requests` 插件： + +```yaml title="conf/config.yaml" plugins: - - ... # plugin you need + - ... - batch-requests ``` -## 如何配置 +## 配置插件 -默认本插件限制请求体的大小不能大于 1 MiB。这个限制可以通过 `apisix/admin/plugin_metadata/batch-requests` 来修改。 +默认情况下，可以发送到 `/apisix/batch-requests` 的最大请求体不能大于 1 MiB。 你可以通过 `apisix/admin/plugin_metadata/batch-requests` 更改插件的此配置： ```shell -curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests \ +-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "max_body_size": 4194304 }' ``` ## 元数据 -| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 | -| ------------- | ------- | ------ | ------- | ------ | ------------------------------ | -| max_body_size | integer | 必选 | 1048576 | > 0 | 请求体的最大大小，单位为字节。 | +| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 | +| ------------- | ------- | -------| ------- | ------ | ---------------------------- | +| max_body_size | integer | 是 | 1048576 |[1, ...]| 请求体的最大大小，单位：bytes。 | -## 批量接口请求/响应 +## 请求和响应格式 -插件会为 `apisix` 创建一个 `/apisix/batch-requests` 的接口来处理你的批量请求。 +该插件会为 `apisix` 创建一个 `/apisix/batch-requests` 的接口来处理你的批量请求。 Review Comment: ```suggestion 该插件会为 `apisix` 创建一个 `/apisix/batch-requests` 接口，用来来处理批量请求。 ``` ########## docs/zh/latest/plugins/batch-requests.md: ########## @@ -23,92 +28,107 @@ title: batch-requests ## 描述 -`batch-requests` 插件可以一次接受多个请求并以 [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式在网关发起多个 http 请求，合并结果后再返回客户端，这在客户端需要访问多个接口时可以显著地提升请求性能。 +`batch-requests` 插件可以一次接受多个请求并以 [HTTP pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式在网关发起多个 HTTP 请求，合并结果后再返回客户端。 -> **提示** -> -> 外层的 Http 请求头会自动设置到每一个独立请求中，如果独立请求中出现相同键值的请求头，那么只有独立请求的请求头会生效。 +在客户端需要访问多个 API 的情况下，这将显著提高性能。 + +:::note + +外部批处理请求的 HTTP 请求头（除了以 `Content-` 开始的请求头，例如：`Content-Type`）适用于**批处理**中的每个请求。 + +如果在外部请求和单个调用中都指定了相同的 HTTP 请求头，则单个调用的请求头优先。 + +::: ## 属性 无 ## 接口 -插件会增加 `/apisix/batch-requests` 这个接口，需要通过 [public-api](../../../en/latest/plugins/public-api.md) 插件来暴露它。 +该插件会增加 `/apisix/batch-requests` 接口。 -## 如何启用 +:::note -你需要在 `config.yaml` 里面启用 batch-requests 插件： +你需要通过 [public-api](../../../zh/latest/plugins/public-api.md) 插件来暴露它。 -``` -# 加到 config.yaml +::: + +## 启用插件 + +该插件默认是禁用状态，你可以配置文件（`./conf/config.yaml`）添加如下配置启用 `batch-requests` 插件： + +```yaml title="conf/config.yaml" plugins: - - ... # plugin you need + - ... - batch-requests ``` -## 如何配置 +## 配置插件 -默认本插件限制请求体的大小不能大于 1 MiB。这个限制可以通过 `apisix/admin/plugin_metadata/batch-requests` 来修改。 +默认情况下，可以发送到 `/apisix/batch-requests` 的最大请求体不能大于 1 MiB。 你可以通过 `apisix/admin/plugin_metadata/batch-requests` 更改插件的此配置： ```shell -curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests \ +-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "max_body_size": 4194304 }' ``` ## 元数据 -| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 | -| ------------- | ------- | ------ | ------- | ------ | ------------------------------ | -| max_body_size | integer | 必选 | 1048576 | > 0 | 请求体的最大大小，单位为字节。 | +| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 | +| ------------- | ------- | -------| ------- | ------ | ---------------------------- | +| max_body_size | integer | 是 | 1048576 |[1, ...]| 请求体的最大大小，单位：bytes。 | -## 批量接口请求/响应 +## 请求和响应格式 -插件会为 `apisix` 创建一个 `/apisix/batch-requests` 的接口来处理你的批量请求。 +该插件会为 `apisix` 创建一个 `/apisix/batch-requests` 的接口来处理你的批量请求。 Review Comment: ```suggestion 该插件会为 `apisix` 创建一个 `/apisix/batch-requests` 接口，用来处理批量请求。 ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
