batch-requests

Description

The batch-requests plugin accepts multiple requests, sends them from APISIX via HTTP pipelining, and returns an aggregated response to the client.

This improves the performance significantly in cases where the client needs to access multiple APIs.

batch-requests - 图1note

The HTTP headers for the outer batch request (except for Content- headers like Content-Type) apply to every request in the batch.

If the same HTTP header is specified in both the outer request and on an individual call, the header of the individual call takes precedence.

Attributes

None.

API

This plugin adds /apisix/batch-requests as an endpoint.

batch-requests - 图2note

You may need to use the public-api plugin to expose this endpoint.

Enabling the Plugin

You can enable the batch-requests Plugin by adding it to your configuration file (conf/config.yaml):

conf/config.yaml

  1. plugins:
  2.   - ...
  3.   - batch-requests

Configuration

By default, the maximum body size that can be sent to /apisix/batch-requests can’t be larger than 1 MiB. You can change this configuration of the Plugin through the endpoint apisix/admin/plugin_metadata/batch-requests:

  1. curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "max_body_size": 4194304
  4. }'

Metadata

NameTypeRequiredDefaultValid valuesDescription
max_body_sizeintegerTrue1048576[1, …]Maximum size of the request body in bytes.

Request and response format

This plugin will create an API endpoint in APISIX to handle batch requests.

Request

NameTypeRequiredDefaultDescription
queryobjectFalseQuery string for the request.
headersobjectFalseHeaders for all the requests.
timeoutintegerFalse30000Timeout in ms.
pipelineHttpRequestTrueDetails of the request.

HttpRequest

NameTypeRequiredDefaultValidDescription
versionstringFalse1.1[1.0, 1.1]HTTP version.
methodstringFalseGET[“GET”, “POST”, “PUT”, “DELETE”, “PATCH”, “HEAD”, “OPTIONS”, “CONNECT”, “TRACE”]HTTP method.
queryobjectFalseQuery string for the request. If set, overrides the value of the global query string.
headersobjectFalseHeaders for the request. If set, overrides the value of the global query string.
pathstringTruePath of the HTTP request.
bodystringFalseBody of the HTTP request.
ssl_verifybooleanFalsefalseSet to verify if the SSL certs matches the hostname.

Response

The response is an array of HttpResponses.

HttpResponse

NameTypeDescription
statusintegerHTTP status code.
reasonstringHTTP reason-phrase.
bodystringHTTP response body.
headersobjectHTTP response headers.

Specifying a custom URI

You can specify a custom URI with the public-api Plugin.

You can set the URI you want when creating the Route and change the configuration of the public-api Plugin:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/br -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/batch-requests",
  4.     "plugins": {
  5.         "public-api": {
  6.             "uri": "/apisix/batch-requests"
  7.         }
  8.     }
  9. }'

Example usage

First, you need to setup a Route to the batch request API. We will use the public-api Plugin for this:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/br -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/apisix/batch-requests",
  4.     "plugins": {
  5.         "public-api": {}
  6.     }
  7. }'

Now you can make a request to the batch request API (/apisix/batch-requests):

  1. curl --location --request POST 'http://127.0.0.1:9080/apisix/batch-requests' \
  2. --header 'Content-Type: application/json' \
  3. --data '{
  4.     "headers": {
  5.         "Content-Type": "application/json",
  6.         "admin-jwt":"xxxx"
  7.     },
  8.     "timeout": 500,
  9.     "pipeline": [
  10.         {
  11.             "method": "POST",
  12.             "path": "/community.GiftSrv/GetGifts",
  13.             "body": "test"
  14.         },
  15.         {
  16.             "method": "POST",
  17.             "path": "/community.GiftSrv/GetGifts",
  18.             "body": "test2"
  19.         }
  20.     ]
  21. }'

This will give a response:

  1. [
  2.   {
  3.     "status": 200,
  4.     "reason": "OK",
  5.     "body": "{\"ret\":500,\"msg\":\"error\",\"game_info\":null,\"gift\":[],\"to_gets\":0,\"get_all_msg\":\"\"}",
  6.     "headers": {
  7.       "Connection": "keep-alive",
  8.       "Date": "Sat, 11 Apr 2020 17:53:20 GMT",
  9.       "Content-Type": "application/json",
  10.       "Content-Length": "81",
  11.       "Server": "APISIX web server"
  12.     }
  13.   },
  14.   {
  15.     "status": 200,
  16.     "reason": "OK",
  17.     "body": "{\"ret\":500,\"msg\":\"error\",\"game_info\":null,\"gift\":[],\"to_gets\":0,\"get_all_msg\":\"\"}",
  18.     "headers": {
  19.       "Connection": "keep-alive",
  20.       "Date": "Sat, 11 Apr 2020 17:53:20 GMT",
  21.       "Content-Type": "application/json",
  22.       "Content-Length": "81",
  23.       "Server": "APISIX web server"
  24.     }
  25.   }
  26. ]

Disable Plugin

You can remove batch-requests from your list of Plugins in your configuration file (conf/config.yaml).