annotation-node v1.0.9

annotation-node

installation

npm install annotation-node

basic example

import express, { Request, Response, NextFunction } from 'express';
import { Controller, Get, ControllerRegistry } from 'annotation-node';

@Controller('/users')
class UserController {
    @Get('/')
    getUsers(req: Request, res: Response) {
        res.send('List of users');
    }
}

@Controller('/products')
class ProductController {
    @Get('/')
    getProducts(req: Request, res: Response) {
        res.send('List of products');
    }
}

const app = express();

ControllerRegistry.addControllers(app, [UserController, ProductController], '/api');

app.listen(3000, () => console.log('Server is running on port 3000'));

Registering Controllers as a Single Array

ControllerRegistry.addControllers(app, [UserController, ProductController]);

Registering grouped controllers

ControllerRegistry.addControllers(app, {
    '/v1': [UserController],
    '/v2': [ProductController]
});

Add prefix for entire API

ControllerRegistry.addControllers(app, [UserController, ProductController], '/api');

Example using multiple HTTP methods

import { Controller, Get, Post, Put, Delete } from 'annotation-node';
import { Request, Response } from 'express';

@Controller('/users')
class UserController {
  @Get('/')
  getUsers(req: Request, res: Response) {
    res.send('List of users');
  }

  @Post('/')
  createUser(req: Request, res: Response) {
    res.send('User created');
  }

  @Put('/:id')
  updateUser(req: Request, res: Response) {
    res.send(`User ${req.params.id} updated`);
  }

  @Delete('/:id')
  deleteUser(req: Request, res: Response) {
    res.send(`User ${req.params.id} deleted`);
  }
}

export default UserController;

Example of using middleware

import express from 'express';
import { Controller, Get, Middleware, ControllerRegistry } from 'annotation-node';

function logger(req: express.Request, res: express.Response, next: () => void) {
    console.log(`Request received at: ${new Date()}`);
    next();
}

function auth(req: express.Request, res: express.Response, next: () => void) {
    if (req.headers['authorization']) {
        next();
    } else {
        res.status(401).send('Unauthorized');
    }
}

@Controller('/user')
@Middleware(logger)
class UserController {
    @Get('/public')
    public getPublicInfo(req: express.Request, res: express.Response) {
        res.send('Public information');
    }

    @Get('/private')
    @Middleware(auth)
    public getPrivateInfo(req: express.Request, res: express.Response) {
        res.send('Private information');
    }
}

const app = express();

ControllerRegistry.addControllers(app, [UserController]);

app.listen(3000, () => console.log('Server is running on port 3000'));