trafficlight
v5.0.1
Published
Flexible NodeJS Routing Decorators for API Routing
Downloads
307
Maintainers
Readme
Trafficlight 🚦
A flexible NodeJS Routing Decorators for API Routing. Features include:
- Built for KOA2
- Bring-your-own router
- Bring-your-own body parser
- TypeScript and ES7 Support
- DI compatible
Usage
Building
npm run build
Install
npm i trafficlight --S
Note: You must have reflect-metadata installed as a peer dependency
Setup KOA
import 'reflect-metadata'; /* Must be singleton */
import * as Koa from 'koa';
import * as Router from 'koa-router';
import * as body from 'koa-better-body';
import { ProfileController } from './controllers';
import { bindRoutes } from 'trafficlight';
export function setupKoa() {
const app = new Koa();
app.use(body());
buildRoutes(app);
app.listen(3000);
return app;
}
function buildRoutes(app) {
const routerRoutes = new Router();
// any router can be used, we support koa-router out of the box
bindRoutes(routerRoutes, [ProfileController]);
// if you are using with some sort of DI system you can pass
// a third parameter callback to get the instance vs new ctrl.
// bindRoutes(routerRoutes, [ProfileController], (ctrl) => injector.get(ctrl));
app.use(routerRoutes.routes());
app.use(routerRoutes.allowedMethods());
}
Decorate the controller
import { Controller, Get, Use, Param, Body, Delete, Put, Post, QueryParam } from 'trafficlight';
@Controller('/profile')
@Use(someMiddleware)
export class ProfileController {
@Get()
getAll(@QueryParam('filter') filter) {
// return []
}
@Get('/:id')
@Use(someMiddleware)
getOne(@Param('id') id) {
// return {}
}
@Post()
create(@Body() body) {
// return {}
}
@Post('/:id/upload')
upload(@Param('id') id, @File() file) {
// return {}
}
@Put('/:id')
update(@Param('id') id, @Body() body) {
// return {}
}
@Delete('/:id')
destroy(@Param('id') id) {
// return success
}
}
API
bindRoutes(routerTable, controllers, getter)
- Binds the controller to the route table.Controller(url?)
- Top level controller decorator. Optional root urlRoute(method, url?)
- Abstract method decorator, accepts method type, urlGet(url?)
- Http GET method, accepts URLPost(url?)
- Http Post method, accepts URLPut(url?)
- Http Put method, accepts URLDelete(url?)
- Http Delete method, accepts URLParams()
- Returns all the parameters passed in the requestParam(val)
- Returns a specific parameter passed in the requestFile()
- Returns a single file in the request bodyFiles()
- Returns all files in the request bodyQueryParams()
- Returns all the query parameters passed in the request url as an objectQueryParam(val)
- Returns a specific query parameter passed in the request urlCtx()
- Returns the KOA context objectReq()
- Returns the Node request objectRequest()
- Returns the KOA request objectRes()
- Returns the Node response objectResponse()
- Returns the KOA response objectBody()
- Returns the request body objectFields()
- Returns the request fields objectUse()
- Middleware decorator for class and functions
Special return types
Since typescript doesn't allow decorators on return types. Certain type has been added to indicate and allow for file download.
FileDownload: {fileName: string, mimeType: string, stream: ReadStream}
Inspiration
Credits
trafficlight
is a Swimlane open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.