Docs

Parameters

See plugin common configurations for configuration options available to all plugins.

  • query

    string

    required

    vaild vaule:

    between 1 and 1024 characters


    GraphQL document sent to the upstream for every matching request.

  • operation_name

    string

    vaild vaule:

    between 1 and 1024 characters


    GraphQL operation to execute. Required when query contains more than one operation.

  • variables

    array[string]


    Names of GraphQL variables to copy from the JSON request body for POST requests or URL query parameters for GET requests.

  • max_req_body_size

    integer

    default: 67108864

    vaild vaule:

    greater than or equal to 1


    Maximum POST request body size in bytes read when extracting configured GraphQL variables. A larger body returns 503 Service Unavailable. The request body is not used when variables is not configured. Introduced in API7 Enterprise 3.9.17 and 3.10.4, and APISIX 3.18.0.