Standardized your RESTful API in TypeScript

restful-api-in-typescript.md

export interface IError {
  message: string;
  code?: string;
  stack?: string;
}

export interface IOrdering {
  column: string;
  order: 'asc' | 'desc';
}

export interface IPagination {
  offset: number;
  limit: number;
  order: IOrdering[];
}

export interface IRecordList<T> extends IPagination {
  total: number;
  records: T[];
}

export interface IBasicResponse {
  success: boolean;
  deprecated?: boolean;
}

export interface IResponseRecord<T> extends IBasicResponse {
  result: T;
}

export interface IResponseList<T> extends IBasicResponse {
  result: IRecordList<T>;
}

export interface IResponseError extends IBasicResponse {
  result: IError;
}

export interface IResponseCommon<T> extends IBasicResponse {
  result: IError | IRecordList<T> | T;
}