Features

• JWT + Redis 验证请求
• 使用 Decorator 开发 Controller Action
• Controller Action 语法示例：

// 前端调用 `POST http://localhost:8084/event/create HTTP/1.1`
@DController('/event')
export class EventController {
  @Post('create')
  @Auth('public')
  async create(
    @BodyParam('event_type') event_type,
  ) {
    const begin_time = new Date()
    const item = await EventService.create({
      begin_time: begin_time,
      event_type: event_type,
    })
    return item
  }
}

• 良好的错误处理机制，Action 中 throw new Error() 即可
• 内部定义了大量常用错误类，如

let result: UserModel = await UserService.getOneByUserName(req.body.user_name)
if(!result) {
 throw new ResourceNotFoundError(`user_name=${req.body.user_name}`)
}
// 接口返回“找不到 user_name=xxx 的资源"

开发约定

API 规范

• 接口输出按照以下格式

{
  "error_code": 10004, // 成功返回为 0
  "message": "状态说明.",
  // other payload
}

decorator 说明

Auth

ControllerAction 的访问权限控制范围，所有 Action 默认开启了 jwt，需要验证登录状态

• Auth('public') 为不验证 jwt，即所有请求都可以通过