Skip to main content

@webda/coreReadme | API


Class: RESTDomainServiceParameters

Extends

Constructors

new RESTDomainServiceParameters(params)

new RESTDomainServiceParameters(params): RESTDomainServiceParameters

Set default url to /

Parameters

params: any

Returns

RESTDomainServiceParameters

Overrides

DomainServiceParameters.constructor

Source

packages/core/src/services/domainservice.ts:356

Properties

exposeOpenAPI

exposeOpenAPI: boolean

Expose the OpenAPI

Default

true if debug false otherwise

Source

packages/core/src/services/domainservice.ts:350


models

models: string[]

List of models to include

If model is prefixed with a ! it will be excluded

Default

["*"]

Inherited from

DomainServiceParameters.models

Source

packages/core/src/services/domainservice.ts:172


nameTransfomer

nameTransfomer: TransformCaseType

Transform the name of the model to be used in the URL

See

https://blog.boot.dev/clean-code/casings-in-coding/#:~:text=%F0%9F%94%97%20Camel%20Case,Go

Inherited from

DomainServiceParameters.nameTransfomer

Source

packages/core/src/services/domainservice.ts:158


openapi?

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore

Inherited from

DomainServiceParameters.openapi

Source

packages/core/src/services/service.ts:260


operations

operations: boolean

Expose objects as operations too

Inherited from

DomainServiceParameters.operations

Source

packages/core/src/services/domainservice.ts:152


queryMethod

queryMethod: "GET" | "PUT"

Method used for query objects

Default

"PUT"

Inherited from

DomainServiceParameters.queryMethod

Source

packages/core/src/services/domainservice.ts:164


type

type: string

Type of the service

Inherited from

DomainServiceParameters.type

Source

packages/core/src/services/service.ts:251


url?

url?: string

URL on which to serve the content

Inherited from

DomainServiceParameters.url

Source

packages/core/src/services/service.ts:255

Methods

isExcluded()

isExcluded(model): boolean

Is a model excluded from the service

Parameters

model: string

Returns

boolean

Inherited from

DomainServiceParameters.isExcluded

Source

packages/core/src/services/domainservice.ts:207


isIncluded()

isIncluded(model): boolean

Is a model is included in the service

Parameters

model: string

Returns

boolean

Inherited from

DomainServiceParameters.isIncluded

Source

packages/core/src/services/domainservice.ts:198