Class: BaseStatusRoute

Defined in: service-core/src/routes/BaseStatusRoute.ts:40

The BaseStatusRoute class provides a base set of endpoints exposing status metadata information about the server.

Included Metadata:

Name	Description
name	The name of the server (e.g. petstore_example)
time	The current UTC timestamp of the server
version	The release version of the server. (e.g. 1.0.0)

Exposed endpoints:

Name	HTTP Method	What it does
get	GET /<base_path>	Returns the server's status metadata

!!Note!! that the BaseAdminRoute is not automatically registered with a server by default. You must create your own class that extends AdminRoute and apply the desired base path with @Route().

Example

import { BaseStatusRoute, RouteDecorators } from "@rapidrest/service-core";
const { Route } = RouteDecorators;

@Route("/status")
export class StatusRoute extends BaseStatusRoute {}

Constructors

Constructor

new BaseStatusRoute(): BaseStatusRoute

Returns

BaseStatusRoute

Properties

serviceName

protected serviceName: any

Defined in: service-core/src/routes/BaseStatusRoute.ts:42

---

serviceVersion

protected serviceVersion: any

Defined in: service-core/src/routes/BaseStatusRoute.ts:44

---

statusExtraData

protected statusExtraData: StatusExtraData | undefined

Defined in: service-core/src/routes/BaseStatusRoute.ts:47

Methods

get()

get(): any

Defined in: service-core/src/routes/BaseStatusRoute.ts:53

Returns

any