nestjs-template

Introduction

nestjs-template 是一个 nestjs 初始化脚手架，提供了一些通用封装，减少重复工作量。

目前实现的功能有：

统一返回数据结构

{
  "data": {
    "msg": "hello"
  },
  "errCode": 0,
  "errMsg": "success"
}

自定义业务 api 异常

默认 statusCode = 200

// 抛出业务 api 异常（默认 statusCode = 200）
@Get('/api-error')
getApiError() {
  throw new ApiException(ApiErrCode.NOT_LOGIN);
}

response：

{
  "errCode": 10000,
  "errMsg": "用户未登录"
}

自定义 statusCode

// 抛出业务 api 异常（自定义 statusCode）
@Get('/api-forbidden')
getApiForbidden() {
  throw new ApiException(ApiErrCode.NOT_LOGIN, HttpStatus.FORBIDDEN);
}

response：

{
  "errCode": 10000,
  "errMsg": "用户未登录"
}