@3kles/3kles-corebe 中文文档教程
3KLES -COREBE
此包包含用于创建 Express 应用程序
API
的
- buildRequest: Method to build the request api from parameters and data
- executeRequest: Method to execute the request
- processResponse: Method called to manage response
- processError: Method called to manage error response
接口和类管理http/s请求协议。
App
IGenericApp 是一个定义如下的接口：
- initAppVariable: Method to init variable (Exemple from dotenv)
- initModule: Method to load module
- initError: Method to manage error
- initRoute: Method to set main router
- startApp: Start app with port number
Router
IGenericRouter 是一个定义如下的接口：
- addController:Method to add route from controller
Controller
IGenericController 是一个定义如下的接口：
- execute: Method to execute request from type
- setService:Method to set IGenericService
- getParameters:Method to get service parameters
- updateParamFromRequest:Method to update controller parameters from request
Service
IGenericService< /strong> 是一个定义如下的接口：
- execute: Method to execute request from parameters
- getParameters:Method to get service parameters
3KLES -COREBE
This package contains interface and class to create Express Application
API
IGenericAPI is an interface with four methods:
- buildRequest: Method to build the request api from parameters and data
- executeRequest: Method to execute the request
- processResponse: Method called to manage response
- processError: Method called to manage error response
In this module there is a class HttpApi that implement IGenericApi to manage http/s request protocol.
App
IGenericApp is an interface defined as below:
- initAppVariable: Method to init variable (Exemple from dotenv)
- initModule: Method to load module
- initError: Method to manage error
- initRoute: Method to set main router
- startApp: Start app with port number
Router
IGenericRouter is an interface defined as below:
- addController:Method to add route from controller
Controller
IGenericController is an interface defined as below:
- execute: Method to execute request from type
- setService:Method to set IGenericService
- getParameters:Method to get service parameters
- updateParamFromRequest:Method to update controller parameters from request
Service
IGenericService is an interface defined as below:
- execute: Method to execute request from parameters
- getParameters:Method to get service parameters
