GatewayApiRoute interface
API route config of the Spring Cloud Gateway
Properties
| description | A description, will be applied to methods in the generated OpenAPI documentation. |
| filters | To modify the request before sending it to the target endpoint, or the received response. |
| order | Route processing order. |
| predicates | A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. |
| sso |
Enable sso validation. |
| tags | Classification tags, will be applied to methods in the generated OpenAPI documentation. |
| title | A title, will be applied to methods in the generated OpenAPI documentation. |
| token |
Pass currently-authenticated user's identity token to application service, default is 'false' |
| uri | Full uri, will override |
Property Details
description
A description, will be applied to methods in the generated OpenAPI documentation.
description?: stringProperty Value
string
filters
To modify the request before sending it to the target endpoint, or the received response.
filters?: string[]Property Value
string[]
order
Route processing order.
order?: numberProperty Value
number
predicates
A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
predicates?: string[]Property Value
string[]
ssoEnabled
Enable sso validation.
ssoEnabled?: booleanProperty Value
boolean
tags
Classification tags, will be applied to methods in the generated OpenAPI documentation.
tags?: string[]Property Value
string[]
title
A title, will be applied to methods in the generated OpenAPI documentation.
title?: stringProperty Value
string
tokenRelay
Pass currently-authenticated user's identity token to application service, default is 'false'
tokenRelay?: booleanProperty Value
boolean
uri
Full uri, will override appName.
uri?: stringProperty Value
string