Qrouter
Router middleware for express
- Provides functionalities provides by default express router
- Adds web socket support for your REST endpoints with no additional code
- Automatic registration of endpoints
Installation
Install using npm:
npm install qrouter
Usage
Initialising middleware
app;
- handler : the express application
- routes : folder to find the router controllers
- paramAware : define if service is param aware (tenant, language etc) or not (optional field), by default param unaware
- paramPrefix : the parameter name to use for the param awarenesses passed in api urls.
Router Controller Structure
var QmrmRouter = ; // include packagevar PARAM_UNAWARE = false;var router = // create router rest: '/prefix' // REST endpoint prefix (all route will be prefixed with it) socket: req: 'prefix.req' // socket request message prefix (all socket request message will be prefixed with it) resp: 'prefix.resp' // socket response message prefix (all socket response message will be prefixed with it) ; routeroptionsPARAM_UNAWARE '/' ;router; router;