Skip to main content

@webda/runtime • Readme | API

Class: ProxyParameters

Proxy to a backend service

Extends​

  • ServiceParameters

Constructors​

new ProxyParameters(params)​

new ProxyParameters(params): ProxyParameters

Parameters​

• params: any

Returns​

ProxyParameters

Overrides​

ServiceParameters.constructor

Source​

runtime/src/services/proxy.ts:61

Properties​

backend​

backend: string

URL to proxy to

Source​

runtime/src/services/proxy.ts:49

openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

ServiceParameters.openapi

Source​

core/lib/services/service.d.ts:104

proxyHeaders​

proxyHeaders: boolean

Add X-Forwarded-* headers

Default​

true

Source​

runtime/src/services/proxy.ts:59

requireAuthentication​

requireAuthentication: boolean

Helper to refuse any request if user is not auth

Source​

runtime/src/services/proxy.ts:53

type​

type: string

Type of the service

Inherited from​

ServiceParameters.type

Source​

core/lib/services/service.d.ts:95

url?​

url?: string

URL to expose

Overrides​

ServiceParameters.url

Source​

runtime/src/services/proxy.ts:45