Class APIService

class: APIService

use internal http-proxy service due to restriction internet-face in VPC lambda.

Hierarchy

APIService

Implements

APIServiceClient

Index

Constructors

constructor

new APIService(type: string, endpoint: string, headers?: APIHeaders, client?: APIServiceClient, proxy?: ApiHttpProxy): APIService
create API service.
```
// basic
const api = new API('web', 'http://localhost:8081', {});
api.doGet('');

// via python
const api = new API('residents', 'http://localhost:8113', {});
api.doGet('123');    // http GET :8113/residents/123

// proxy server
const api = new API('web', 'http://localhost:8081', {}, null, proxy);
api.doGet('');
```
Parameters
- type: string
  
  type in endpoint
- endpoint: string
  
  base endpoint (support ONLY http, https)
- Optional headers: APIHeaders
  
  common headers.
- Optional client: APIServiceClient
  
  real api-client to use (or use proxy, or create default)
- Optional proxy: ApiHttpProxy
  
  proxy-service to use if there is no client (or use backbone server)
Returns APIService
- Defined in src/cores/api/api-service.ts:139

Properties

`Protected` client

client: APIServiceClient

`Protected` endpoint

endpoint: string

`Protected` headers

headers: APIHeaders

`Protected` type

type: string

`Static` APIServiceClientRecorder

APIServiceClientRecorder: typeof __class = ...

recorder of api-service client.

`Static` ApiHttpProxyRecorder

ApiHttpProxyRecorder: typeof __class = ...

recorder of api-http-proxy client.

`Static` `Private` ProxyServiceClient

ProxyServiceClient: typeof __class = ...

class: TypedEndpoint

by using common proxy, extends endpoint by type.
endpoint := base+'/'+type.

`Static` SubTypeClient

SubTypeClient: typeof __class = ...

use sub-typed endpoint.

extends as endpoint := parent.endpoint + '/' + type

Methods

buildRecorder

buildRecorder(folder?: string): APIServiceClient
make api recorder of this service.
Parameters
- Optional folder: string
  
  base folder (default ./logs)
Returns APIServiceClient
- Defined in src/cores/api/api-service.ts:218

buildSubTypeClient

buildSubTypeClient(type: string, useRecord?: boolean, folder?: string): APIServiceClient
make a client for sub-typed endpoint.
Parameters
- type: string
  
  sub-type path.
- Optional useRecord: boolean
- Optional folder: string
Returns APIServiceClient
- Defined in src/cores/api/api-service.ts:209

doDelete

doDelete<T>(id: string, cmd?: string, $param?: any, $body?: any, hash?: string): Promise<T>
DELETE HOST/PATH?$param
Type Parameters
- T = any
Parameters
- id: string
- Optional cmd: string
- Optional $param: any
- Optional $body: any
- Optional hash: string
Returns Promise<T>
Implementation of APIServiceClient.doDelete
- Defined in src/cores/api/api-service.ts:476

doGet

doGet<T>(id: string, cmd?: string, $param?: any, $body?: any, hash?: string): Promise<T>
GET HOST/PATH?$param
Type Parameters
- T = any
Parameters
- id: string
- Optional cmd: string
- Optional $param: any
- Optional $body: any
- Optional hash: string
Returns Promise<T>
Implementation of APIServiceClient.doGet
- Defined in src/cores/api/api-service.ts:448

doPatch

doPatch<T>(id: string, cmd?: string, $param?: any, $body?: any, hash?: string): Promise<T>
PATCH HOST/PATH?$param
Type Parameters
- T = any
Parameters
- id: string
- Optional cmd: string
- Optional $param: any
- Optional $body: any
- Optional hash: string
Returns Promise<T>
Implementation of APIServiceClient.doPatch
- Defined in src/cores/api/api-service.ts:469

doPost

doPost<T>(id: string, cmd?: string, $param?: any, $body?: any, hash?: string): Promise<T>
POST HOST/PATH?$param
Type Parameters
- T = any
Parameters
- id: string
- Optional cmd: string
- Optional $param: any
- Optional $body: any
- Optional hash: string
Returns Promise<T>
Implementation of APIServiceClient.doPost
- Defined in src/cores/api/api-service.ts:462

doPut

doPut<T>(id: string, cmd?: string, $param?: any, $body?: any, hash?: string): Promise<T>
PUT HOST/PATH?$param
Type Parameters
- T = any
Parameters
- id: string
- Optional cmd: string
- Optional $param: any
- Optional $body: any
- Optional hash: string
Returns Promise<T>
Implementation of APIServiceClient.doPut
- Defined in src/cores/api/api-service.ts:455

hello

hello(): string
Returns string
Implementation of APIServiceClient.hello
- Defined in src/cores/api/api-service.ts:164

`Static` buildClient

buildClient(type: string, endpoint: string, headers?: APIHeaders, backbone?: string, proxy?: ApiHttpProxy): APIServiceClient
helper to make http client
Parameters
- type: string
- endpoint: string
- Optional headers: APIHeaders
- Optional backbone: string
  
  backbone address like 'http://localhost:8081'
- Optional proxy: ApiHttpProxy
Returns APIServiceClient
- Defined in src/cores/api/api-service.ts:171

Class APIService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

type: string

endpoint: string

Optional headers: APIHeaders

Optional client: APIServiceClient

Optional proxy: ApiHttpProxy

Returns APIService

Properties

Protected client

Protected endpoint

Protected headers

Protected type

Static APIServiceClientRecorder

Static ApiHttpProxyRecorder

Static Private ProxyServiceClient

Static SubTypeClient

Methods

buildRecorder

Parameters

Optional folder: string

Returns APIServiceClient

buildSubTypeClient

Parameters

type: string

Optional useRecord: boolean

Optional folder: string

Returns APIServiceClient

doDelete

Type Parameters

T = any

Parameters

id: string

Optional cmd: string

Optional $param: any

Optional $body: any

Optional hash: string

Returns Promise<T>

doGet

Type Parameters

T = any

Parameters

id: string

Optional cmd: string

Optional $param: any

Optional $body: any

Optional hash: string

Returns Promise<T>

doPatch

Type Parameters

T = any

Parameters

id: string

Optional cmd: string

Optional $param: any

Optional $body: any

Optional hash: string

Returns Promise<T>

doPost

Type Parameters

T = any

Parameters

id: string

Optional cmd: string

Optional $param: any

Optional $body: any

Optional hash: string

Returns Promise<T>

doPut

Type Parameters

T = any

Parameters

`Optional` headers: APIHeaders

`Optional` client: APIServiceClient

`Optional` proxy: ApiHttpProxy

`Protected` client

`Protected` endpoint

`Protected` headers

`Protected` type

`Static` APIServiceClientRecorder

`Static` ApiHttpProxyRecorder

`Static` `Private` ProxyServiceClient

`Static` SubTypeClient

`Optional` folder: string

`Optional` useRecord: boolean

`Optional` folder: string

`Optional` cmd: string

`Optional` $param: any

`Optional` $body: any

`Optional` hash: string

`Optional` cmd: string

`Optional` $param: any

`Optional` $body: any

`Optional` hash: string

`Optional` cmd: string

`Optional` $param: any

`Optional` $body: any

`Optional` hash: string

`Optional` cmd: string

`Optional` $param: any

`Optional` $body: any

`Optional` hash: string

`Optional` cmd: string

`Optional` $param: any

`Optional` $body: any

`Optional` hash: string

`Static` buildClient

`Optional` headers: APIHeaders

`Optional` backbone: string

`Optional` proxy: ApiHttpProxy