RouteAliasDefinition

@webda/core

---

Interface: RouteAliasDefinition

Defined in: packages/core/src/rest/router.service.ts:29

Full definition of a route alias

Properties

methods?

optional methods?: HttpMethodType[]

Defined in: packages/core/src/rest/router.service.ts:36

Methods the alias applies to

Default

all methods

---

mode?

optional mode?: RouteAliasMode

Defined in: packages/core/src/rest/router.service.ts:38

rewrite: served in-process, redirect: HTTP redirect to the target

Default

"rewrite"

---

openapi?

optional openapi?: boolean

Defined in: packages/core/src/rest/router.service.ts:42

Document the alias in OpenAPI

Default

true for rewrite, false for redirect

---

redirectCode?

optional redirectCode?: 301 | 302 | 307 | 308

Defined in: packages/core/src/rest/router.service.ts:40

Status code used in redirect mode

Default

302

---

target

target: string

Defined in: packages/core/src/rest/router.service.ts:34

Target URL, relative to the application (routePrefix is applied like routes) Supports ${user.id} and ${params.} placeholders