Class AkeraRestCatalogApi

The implementation of the akera.io business logic API middleware.

Hierarchy

AkeraRestApi
- AkeraRestCatalogApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AkeraRestCatalogApi(webApp: AkeraWeb, catalog: IAPICatalog): AkeraRestCatalogApi

Overrides AkeraRestApi.constructor

Parameters
- webApp: AkeraWeb
  
  The @akera/web instance holding the application server(s) information.
- catalog: IAPICatalog
  
  The business logic catalog definition.
Returns AkeraRestCatalogApi

Properties

Protected _catalog

_catalog: IAPICatalog

Protected _router

_router: express.Router

Protected _webApp

_webApp: AkeraWeb

Methods

Protected _error

_error(err: Error | string, res?: express.Response, code?: number): void

Inherited from AkeraRestApi._error

Parameters
- err: Error | string
- Optional res: express.Response
- Optional code: number
Returns void

Protected _getDirection

_getDirection(direction: string): Direction

Inherited from AkeraRestApi._getDirection

Parameters
- direction: string
Returns Direction

Protected _getEnum

_getEnum(oEnum: Object, value: string | number): string | number

Inherited from AkeraRestApi._getEnum

Parameters
- oEnum: Object
- value: string | number
Returns string | number

Protected _getInputParameterValue

_getInputParameterValue(req: express.Request, cgi: IWebCgi, map: IRequestParameterMap): any

Parameters
- req: express.Request
- cgi: IWebCgi
- map: IRequestParameterMap
Returns any

Protected _getParameter

_getParameter(p: Object, version?: number): IParameter

Inherited from AkeraRestApi._getParameter

Parameters
- p: Object
- Optional version: number
Returns IParameter

Protected _getRequestCall

_getRequestCall(req: Object, type?: ABLType, call?: string, method?: string): IABLCall

Inherited from AkeraRestApi._getRequestCall

Parameters
- req: Object
- Optional type: ABLType
- Optional call: string
- Optional method: string
Returns IABLCall

Protected _handleRequest

_handleRequest(broker: string, req: express.Request, res: express.Response, type?: ABLType, call?: string, method?: string): Promise<void>

Inherited from AkeraRestApi._handleRequest

Parameters
- broker: string
- req: express.Request
- res: express.Response
- Optional type: ABLType
- Optional call: string
- Optional method: string
Returns Promise<void>

Protected _log

_log(level: LogLevel, message: string): void

Inherited from AkeraRestApi._log

Parameters
- level: LogLevel
- message: string
Returns void

Protected _mount

_mount(broker?: string): express.Router

Overrides AkeraRestApi._mount

Parameters
- Optional broker: string
Returns express.Router

Protected _setOutputParameter

_setOutputParameter(res: express.Response, map: IParameterMap, ret: any[]): void

Parameters
- res: express.Response
- map: IParameterMap
- ret: any[]
Returns void

init

init(): express.Router

Inherited from AkeraRestApi.init

Returns the middleware that can be used to mount the API interface.

Returns express.Router