API-Kit

Typescript utility KIT for Express apis, including sequelize tools.

available on NPM

Installation

1npm i @d-lab/api-kit

Usage

• Add Error middleware to your App

1import express from "express"
2
3const app = express()
4app.use(errorMiddleware)

• Declare API handler in your routes, removing Express from your Controllers logic

1// from routes/user.route.ts
2import {Router} from "express"
3import {handle} from "../interfaces/api"
4
5// your own controller
6import UserController from "../controllers/user.controller"
7import {validateRequest} from "../middleware"
8const ctrl = new UserController()
9
10const router = Router()
11router.get("/users/:userId", handle.bind(ctrl.get))
12router.post("/users", validateRequest(CreateRequest), handle.bind(ctrl.create))
13
14export default router

• Compile your routes in /routes/index.ts

1import userRouter from "./user.route"
2const routers = [
3  userRouter
4]
5export default routers

• Add routes to your App

1import routers from "./routes"
2app.use(routers)

• Create your Controllers
  • You can now consider your controllers as simple methods without considering Express anymore
  • The success response will be handled in the router and the possible errors will be handled by the error middleware when HttpException are thrown in your code

1import {PathRequest, AuthBodyRequest} from "../interfaces/api"
2
3export default class UserController {
4    public get = async (req: PathRequest<GetRequest>): Promise<UserResponse> => {
5        const params = req.params
6        return {}
7    }
8    public create = async (req: BodyRequest<CreateRequest>): Promise<UserResponse> => {
9        const body = req.body
10        return {}
11    }
12}