如何制作返回带有状态和 json. 的响应的结构接口？

Question

我有一个描述响应有效负载的接口。

export interface ObjectResponseInterface {
    status : HttpStatusCode,
    error : Boolean,
    response : any
}

我创建了一个键入到ObjectResponseInterface的响应 object ，但我想创建一个始终返回此 obj、 objRes和res.status以及res.json(objRes.status)的结构，如下所示

const objRes : ObjectResponseInterface = {
        status : HttpStatusCode.BAD_REQUEST,
        error : false,
        response : response
      }
        
res.status(objRes.status).json(objRes)

有没有办法将此响应实现为接口，也许可以扩展 Express？

Answer 1

如果我遗漏了什么，请纠正我。 我认为您可以使用通用方法来做到这一点。

例如

// Generic Definition
export interface ApiResponse<T> {
  // "httpStatus" have to return the status as a number
  // because res.status accepts a number as a parameter.
  status: number,  
  error: boolean,
  response: T
}


// Usage Examples

// Response as primitive type
const objRes: ApiResponse<string> = {
  status: httpStatus.BAD_REQUEST,
  error: false,
  response: 'Request gone wrong'
}

res.status(objRes.status).json(objRes)

// Response as custom type
export type CustomType = {
  id: number,
  name: string
}

const objRes: ApiResponse<CustomType> = {
  status: 200,
  error: false,
  response: { id: 1, name: 'test' }
}

res.status(objRes.status).json(objRes)