Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GatewayApiRoute

Package version

API route config of the Spring Cloud Gateway

Hierarchy

  • GatewayApiRoute

Index

Properties

Optional description

description: undefined | string

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

Optional filters

filters: string[]

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

Optional order

order: undefined | number

Route processing order.

Optional predicates

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.

Optional ssoEnabled

ssoEnabled: undefined | false | true

Enable sso validation.

Optional tags

tags: string[]

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

Optional title

title: undefined | string

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

Optional tokenRelay

tokenRelay: undefined | false | true

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

Optional uri

uri: undefined | string

Full uri, will override appName.

Generated using TypeDoc