Skip to content

ApiInterceptors

Thiago da Rosa de Bustamante edited this page Mar 27, 2018 · 1 revision

Configure request and response to the request pipeline.

It supports the following properties:

Property Type Description Required
request Interceptor[] A list of request interceptor names true
response Interceptor[] A list of response interceptor names true

Interceptor

Configure a request or response interceptor.

It supports the following properties:

Property Type Description Required
middleware MiddlewareConfig The Interceptor configuration. false
group string[] A list of group names that should be intercepted by this interceptor. If not provided, everything will be intercepted. false
use string Import a configuration from gateway config session. false

You must provide one of middleware or use property.

Example:

{
    "interceptor": {
        "request": [
            {
                "middleware": {
                    "name":"myRequestInterceptor"
                }, 
                "group": ["Group1"]
            },
            {
                "middleware": {
                    "name":"mySecondRequestInterceptor"
                }
            },
            {
                "use": "my-interceptor"
            }
        ], 
        "response": [
            {
                "middleware": {
                    "name":"myResponseInterceptor"}
                }, 
            {
                "middleware": {
                    "name":"SecondInterceptor"
                }, 
                "group": ["Group1"]
            },
            {
                "use": "my-other-interceptor", 
                "group": ["Group1"]
            }
        ] 
    }
}

or

interceptor:
    request:
        - middleware:
            name: myRequestInterceptor
          group:
            - Group1
        - middleware:
            name: mySecondRequestInterceptor
        - use: my-interceptor
    response:
        - middleware:
            name: myResponseInterceptor
        - middleware:
            name: SecondInterceptor
          group:
            - Group1
        - use: my-other-interceptor
          group: Group2
Clone this wiki locally