title |
---|
batch-requests |
- Description
- Attributes
- How To Enable
- How To Configure
- Metadata
- Batch Api Request/Response
- Test Plugin
- Disable Plugin
batch-requests
can accept multiple request and send them from apisix
via http pipeline, and return an aggregated response to client, which can significantly improve performance when the client needs to access multiple APIs.
Tips
The HTTP headers for the outer batch request, except for the Content- headers such as Content-Type, apply to every request in the batch. If you specify a given HTTP header in both the outer request and the individual call, the header's value of individual call would override the outer batch request header's value. The headers for an individual call apply only to that call.
None
This plugin will add /apisix/batch-requests
as the endpoint.
You may need to use interceptors to protect it.
Enable the batch-requests plugin in the config.yaml
:
# Add this in config.yaml
plugins:
- ... # plugin you need
- batch-requests
By default, the maximum body size sent to the /apisix/batch-requests
can't be larger than 1 MiB.
You can configure it via apisix/admin/plugin_metadata/batch-requests
:
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
}'
Name | Type | Requirement | Default | Valid | Description |
---|---|---|---|---|---|
max_body_size | integer | required | 1048576 | > 0 | the maximum of request body size in bytes |
The plugin will create a API in apisix
to handle your batch request.
Name | Type | Requirement | Default | Valid | Description |
---|---|---|---|---|---|
query | object | optional | Specify QueryString for all request |
||
headers | object | optional | Specify Header for all request |
||
timeout | integer | optional | 30000 | Aggregate API timeout in ms |
|
pipeline | HttpRequest | required | Request's detail |
Name | Type | Requirement | Default | Valid | Description |
---|---|---|---|---|---|
version | string | optional | 1.1 | [1.0, 1.1] | http version |
method | string | optional | GET | ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS", "CONNECT", "TRACE"] | http method |
query | object | optional | request's QueryString , if Key is conflicted with global query , this setting's value will be used. |
||
headers | object | optional | request's Header , if Key is conflicted with global headers , this setting's value will be used. |
||
path | string | required | http request's path | ||
body | string | optional | http request's body | ||
ssl_verify | boolean | optional | false | verify if SSL cert matches hostname. |
Response is Array
of HttpResponse.
Name | Type | Description |
---|---|---|
status | integer | http status code |
reason | string | http reason phrase |
body | string | http response body |
headers | object | http response headers |
We can change the default uri in the plugin_attr
section of conf/config.yaml
.
Name | Type | Requirement | Default | Description |
---|---|---|---|---|
uri | string | optional | "/apisix/batch-requests" | uri to use with batch-requests plugin |
Here is an example:
plugin_attr:
batch-requests:
uri: "/api-gw/batch"
You can pass your request detail to batch API( /apisix/batch-requests
), apisix
can automatically complete requests via http pipeline. Such as:
curl --location --request POST 'http://127.0.0.1:9080/apisix/batch-requests' \
--header 'Content-Type: application/json' \
--data '{
"headers": {
"Content-Type": "application/json",
"admin-jwt":"xxxx"
},
"timeout": 500,
"pipeline": [
{
"method": "POST",
"path": "/community.GiftSrv/GetGifts",
"body": "test"
},
{
"method": "POST",
"path": "/community.GiftSrv/GetGifts",
"body": "test2"
}
]
}'
response as below:
[
{
"status": 200,
"reason": "OK",
"body": "{\"ret\":500,\"msg\":\"error\",\"game_info\":null,\"gift\":[],\"to_gets\":0,\"get_all_msg\":\"\"}",
"headers": {
"Connection": "keep-alive",
"Date": "Sat, 11 Apr 2020 17:53:20 GMT",
"Content-Type": "application/json",
"Content-Length": "81",
"Server": "APISIX web server"
}
},
{
"status": 200,
"reason": "OK",
"body": "{\"ret\":500,\"msg\":\"error\",\"game_info\":null,\"gift\":[],\"to_gets\":0,\"get_all_msg\":\"\"}",
"headers": {
"Connection": "keep-alive",
"Date": "Sat, 11 Apr 2020 17:53:20 GMT",
"Content-Type": "application/json",
"Content-Length": "81",
"Server": "APISIX web server"
}
}
]
Normally, you don't need to disable this plugin. If you do need, please make a new list of plugins
you need in /conf/config.yaml
to cover the original one.