simple-decor v1.0.3

simple-decor

Purpose

Modern REST API frameworks allow simple syntax to register new routes and type check their data transfer object (DTO). In express, these processes can be verbose, but migrating to newer frameworks is not always an option.

The goal of simple-decor is to bring in uncomplicated decorator-based route registration and DTO type checking to Express projects. Additionally, it plans to include automatic OpenAPI documentation generation in upcoming versions.

Installation

Using npm:

$ npm i simple-decor

Usage

Register a POST company/:companyId/user and DTO type checking using controller decorators

import { Post, ParamIsInt, BodyIsClass } from "simple-decor";

class UserController {
  @Post("company/:companyId/user")
  @ParamIsInt("companyId")
  @BodyIsClass(PostUserBody)
  post(req: Request, res: Response) {
    const { email, name } = req.body as PostUserBody;

    //create user ...

    res.send(200);
  }
}

Add registered routes to express application

import { setup } from "simple-decor";

const app = express();
app.listen(3000);
setup(app);

Decorators

Route registration

Path param type checking

Query param type checking

Body type checking