express decorators
This is a convience library to make creating routes for express REST services cleaner.
*$ npm install expressjs-decorators
- Create models, business logic and any data access classes required
UserService.ts
import {UserRepository} from '../repositories/UserRepository';
export class UserService {
private _userRepository: UserRepository;
constructor(userRepository: UserRepository) {
this._userRepository = userRepository;
}
public async getUser(id: number): Promise<User> {
let user = await this._userRepository.getUser(id);
return user;
}
}
- Create your REST API
UserController.ts
import {UserService} from '../services/UserService';
import {Response as ExpressResponse} from 'express';
import {Controller, Get, CatchAndSendError, Response, NumParam} from 'expressjs-decorators';
@Controller('/users')
export class UserController {
private _userService: UserService;
constructor(userService: UserService) {
this._userService = userService;
}
@CatchAndSendError()
@Get('/:userId')
public async getUser(@Response() res: ExpressResponse, @NumParam('userId') id: number): Promise<void> {
let user = await this._userService.getUser(id);
res.location(`/api/users/${user.id}`);
res.json({user: user});
}
}
- Set up dependency injection container and start an HTTP listener
index.ts
import {registerController} from 'expressjs-decorators';
import * as express from 'express';
import {Router} from 'express';
import {UserController} from './controllers/UserController';
// create express application
const app: express.Application = express();
const apiRouter = Router();
let userRepo = new UserRepository();
let userController = new UserController(new UserService(userRepo));
// register controllers
registerController(apiRouter, userController);
app.use('/api', apiRouter);
// run http listener
const server: Server = app.listen(8080, (error: Error) => {
if (error != null) {
console.log(error);
} else {
console.log('server listening over insecure http on port 8080');
}
});
- You should now have a useable api endpoint at:
localhost:8080/api/users/[id]