Package version:

Interface GatewayApiRoute

API route config of the Spring Cloud Gateway

Hierarchy

  • GatewayApiRoute

Properties

description?: string

A description, will be applied to methods in the generated OpenAPI documentation.

filters?: string[]

To modify the request before sending it to the target endpoint, or the received response.

order?: number

Route processing order.

predicates?: string[]

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.

ssoEnabled?: boolean

Enable sso validation.

tags?: string[]

Classification tags, will be applied to methods in the generated OpenAPI documentation.

title?: string

A title, will be applied to methods in the generated OpenAPI documentation.

tokenRelay?: boolean

Pass currently-authenticated user's identity token to application service, default is 'false'

uri?: string

Full uri, will override appName.

Generated using TypeDoc