@delysium/api-kit

Utility KIT for Express apis.

Installation

1npm i @delysium/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

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

• Add routes to your App

1import userRouter from "./routes/user.route"
2app.use(userRouter)

• 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}