Package version:

Interface GatewayApiMetadataProperties

API metadata property for Spring Cloud Gateway

Hierarchy

  • GatewayApiMetadataProperties

Properties

description? documentation? serverUrl? title? version?

Properties

Optional description

description?: string

Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes the API routes configured.)

Optional documentation

documentation?: string

Location of additional documentation for the APIs available on the Gateway instance

Optional serverUrl

serverUrl?: string

Base URL that API consumers will use to access APIs on the Gateway instance.

Optional title

title?: string

Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)

Optional version

version?: string

Version of APIs available on this Gateway instance (default: unspecified).

Settings

Member Visibility

Theme

Generated using TypeDoc