API/src/utils/response.util.ts

57 lines
1.0 KiB
TypeScript

import { ApiProperty } from "@midwayjs/swagger";
// 通用响应结构
export class ApiResponse<T> {
@ApiProperty({ description: '状态码' })
code: number;
@ApiProperty({ description: '是否成功' })
success: boolean;
@ApiProperty({ description: '提示信息' })
message: string;
@ApiProperty({ description: '返回数据' })
data: T;
}
/**
* 成功响应
* @param data 返回的数据
* @param message 提示信息
* @param code 状态码
* @returns ApiResponse
*/
export function successResponse<T>(
data: T = {} as T,
message = '操作成功',
code = 200
): ApiResponse<T> {
return {
success: true,
message,
data,
code,
};
}
/**
* 错误响应
* @param message 错误信息
* @param code 状态码
* @param data 返回的错误数据
* @returns ApiResponse
*/
export function errorResponse<T>(
message = '操作失败',
code = 500,
data: T = {} as T
): ApiResponse<T> {
return {
success: false,
message: message,
data,
code,
};
}