smart-flow/yudao-ui-admin-vben
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat：【antd/ele】【mall/stat】优化 api 的注释

Browse Source
This commit is contained in:
YunaiV
2025-11-20 11:05:51 +08:00
parent f278ebaf79
commit cf581f3bb3
8 changed files with 63 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
apps/web-antd/src/api/mall/statistics/trade.ts
View File

@@ -1,25 +1,25 @@
import type { DataComparisonRespVO } from './common'; import type { DataComparisonRespVO } from './common';
import { formatDate, formatDateTime } from '@vben/utils'; import { formatDateTime } from '@vben/utils';
import { requestClient } from '#/api/request'; import { requestClient } from '#/api/request';
export namespace MallTradeStatisticsApi { export namespace MallTradeStatisticsApi {
/** 交易状况 Request */
export interface TradeTrendReqVO {
times: [Date, Date];
}
/** 交易统计 Response */ /** 交易统计 Response */
export interface TradeSummary { export interface TradeSummaryRespVO {
yesterdayOrderCount: number; yesterdayOrderCount: number;
monthOrderCount: number; monthOrderCount: number;
yesterdayPayPrice: number; yesterdayPayPrice: number;
monthPayPrice: number; monthPayPrice: number;
} }
/** 交易状况 Request */
export interface TradeTrendReq {
times: [Date, Date];
}
/** 交易状况统计 Response */ /** 交易状况统计 Response */
export interface TradeTrendSummary { export interface TradeTrendSummaryRespVO {
time: string; time: string;
turnoverPrice: number; turnoverPrice: number;
orderPayPrice: number; orderPayPrice: number;
@@ -31,60 +31,46 @@ export namespace MallTradeStatisticsApi {
} }
/** 交易订单数量 Response */ /** 交易订单数量 Response */
export interface TradeOrderCount { export interface TradeOrderCountRespVO {
/** 待发货 */ undelivered?: number; // 待发货
undelivered?: number; pickUp?: number; // 待核销
/** 待核销 */ afterSaleApply?: number; // 退款中
pickUp?: number; auditingWithdraw?: number; // 提现待审核
/** 退款中 */
afterSaleApply?: number;
/** 提现待审核 */
auditingWithdraw?: number;
} }
/** 交易订单统计 Response */ /** 交易订单统计 Response */
export interface TradeOrderSummaryRespVO { export interface TradeOrderSummaryRespVO {
/** 支付订单商品数 */ orderPayCount?: number; // 支付订单商品数
orderPayCount?: number; orderPayPrice?: number; // 总支付金额，单位：分
/** 总支付金额，单位：分 */
orderPayPrice?: number;
} }
/** 订单量趋势统计 Response */ /** 订单量趋势统计 Response */
export interface TradeOrderTrend { export interface TradeOrderTrendRespVO {
/** 日期 */ date: string; // 日期
date: string; orderPayCount: number; // 订单数量
/** 订单数量 */ orderPayPrice: number; // 订单支付金额
orderPayCount: number;
/** 订单支付金额 */
orderPayPrice: number;
} }
} }
/** 时间参数需要格式化, 确保接口能识别 */
const formatDateParam = (params: MallTradeStatisticsApi.TradeTrendReq) => {
return {
times: [formatDate(params.times[0]), formatDate(params.times[1])],
} as MallTradeStatisticsApi.TradeTrendReq;
};
/** 查询交易统计 */ /** 查询交易统计 */
export function getTradeStatisticsSummary() { export function getTradeStatisticsSummary() {
return requestClient.get< return requestClient.get<
DataComparisonRespVO<MallTradeStatisticsApi.TradeSummary> DataComparisonRespVO<MallTradeStatisticsApi.TradeSummaryRespVO>
>('/statistics/trade/summary'); >('/statistics/trade/summary');
} }
/** 获得交易状况统计 */ /** 获得交易状况统计 */
export function getTradeStatisticsAnalyse(params: any) { export function getTradeStatisticsAnalyse(
params: MallTradeStatisticsApi.TradeTrendReqVO,
) {
return requestClient.get< return requestClient.get<
DataComparisonRespVO<MallTradeStatisticsApi.TradeTrendSummary> DataComparisonRespVO<MallTradeStatisticsApi.TradeTrendSummaryRespVO>
>('/statistics/trade/analyse', { params }); >('/statistics/trade/analyse', { params });
} }
/** 获得交易状况明细 */ /** 获得交易状况明细 */
export function getTradeStatisticsList(params: any) { export function getTradeStatisticsList(params: any) {
return requestClient.get<MallTradeStatisticsApi.TradeTrendSummary[]>( return requestClient.get<MallTradeStatisticsApi.TradeTrendSummaryRespVO[]>(
'/statistics/trade/list', '/statistics/trade/list',
{ params }, { params },
); );
@@ -97,7 +83,7 @@ export function exportTradeStatisticsExcel(params: any) {
/** 获得交易订单数量 */ /** 获得交易订单数量 */
export function getOrderCount() { export function getOrderCount() {
return requestClient.get<MallTradeStatisticsApi.TradeOrderCount>( return requestClient.get<MallTradeStatisticsApi.TradeOrderCountRespVO>(
'/statistics/trade/order-count', '/statistics/trade/order-count',
); );
} }
@@ -116,7 +102,7 @@ export function getOrderCountTrendComparison(
endTime: Date, endTime: Date,
) { ) {
return requestClient.get< return requestClient.get<
DataComparisonRespVO<MallTradeStatisticsApi.TradeOrderTrend>[] DataComparisonRespVO<MallTradeStatisticsApi.TradeOrderTrendRespVO>[]
>('/statistics/trade/order-count-trend', { >('/statistics/trade/order-count-trend', {
params: { params: {
type, type,

2
apps/web-antd/src/views/mall/statistics/trade/index.vue
View File

@@ -18,7 +18,7 @@ defineOptions({ name: 'TradeStatistics' });
const loading = ref(true); // 加载中 const loading = ref(true); // 加载中
const summary = const summary =
ref<DataComparisonRespVO<MallTradeStatisticsApi.TradeSummary>>(); // 交易统计数据 ref<DataComparisonRespVO<MallTradeStatisticsApi.TradeSummaryRespVO>>(); // 交易统计数据
/** 计算环比百分比 */ /** 计算环比百分比 */
function calculateRelativeRate(value?: number, reference?: number): string { function calculateRelativeRate(value?: number, reference?: number): string {

2
apps/web-antd/src/views/mall/statistics/trade/modules/trend-card.vue
View File

@@ -37,7 +37,7 @@ defineOptions({ name: 'TradeTrendCard' });
const trendLoading = ref(true); // 交易状态加载中 const trendLoading = ref(true); // 交易状态加载中
const exportLoading = ref(false); // 导出的加载中 const exportLoading = ref(false); // 导出的加载中
const trendSummary = const trendSummary =
ref<DataComparisonRespVO<MallTradeStatisticsApi.TradeTrendSummary>>(); // 交易状况统计数据 ref<DataComparisonRespVO<MallTradeStatisticsApi.TradeTrendSummaryRespVO>>(); // 交易状况统计数据
const searchTimes = ref<string[]>([]); const searchTimes = ref<string[]>([]);
const chartRef = ref<EchartsUIType>(); const chartRef = ref<EchartsUIType>();

2
apps/web-antd/src/views/mall/statistics/trade/modules/trend-chart-options.ts
View File

@@ -4,7 +4,7 @@ import { fenToYuan } from '@vben/utils';
/** 交易趋势折线图配置 */ /** 交易趋势折线图配置 */
export function getTradeTrendChartOptions( export function getTradeTrendChartOptions(
data: MallTradeStatisticsApi.TradeTrendSummary[], data: MallTradeStatisticsApi.TradeTrendSummaryRespVO[],
): any { ): any {
// 处理数据：将分转换为元 // 处理数据：将分转换为元
const processedData = data.map((item) => ({ const processedData = data.map((item) => ({

82
apps/web-ele/src/api/mall/statistics/trade.ts
View File

@@ -1,25 +1,25 @@
import type { DataComparisonRespVO } from './common'; import type { DataComparisonRespVO } from './common';
import { formatDate, formatDateTime } from '@vben/utils'; import { formatDateTime } from '@vben/utils';
import { requestClient } from '#/api/request'; import { requestClient } from '#/api/request';
export namespace MallTradeStatisticsApi { export namespace MallTradeStatisticsApi {
/** 交易状况 Request */
export interface TradeTrendReqVO {
times: [Date, Date];
}
/** 交易统计 Response */ /** 交易统计 Response */
export interface TradeSummary { export interface TradeSummaryRespVO {
yesterdayOrderCount: number; yesterdayOrderCount: number;
monthOrderCount: number; monthOrderCount: number;
yesterdayPayPrice: number; yesterdayPayPrice: number;
monthPayPrice: number; monthPayPrice: number;
} }
/** 交易状况 Request */
export interface TradeTrendReq {
times: [Date, Date];
}
/** 交易状况统计 Response */ /** 交易状况统计 Response */
export interface TradeTrendSummary { export interface TradeTrendSummaryRespVO {
time: string; time: string;
turnoverPrice: number; turnoverPrice: number;
orderPayPrice: number; orderPayPrice: number;
@@ -31,81 +31,59 @@ export namespace MallTradeStatisticsApi {
} }
/** 交易订单数量 Response */ /** 交易订单数量 Response */
export interface TradeOrderCount { export interface TradeOrderCountRespVO {
/** 待发货 */ undelivered?: number; // 待发货
undelivered?: number; pickUp?: number; // 待核销
/** 待核销 */ afterSaleApply?: number; // 退款中
pickUp?: number; auditingWithdraw?: number; // 提现待审核
/** 退款中 */
afterSaleApply?: number;
/** 提现待审核 */
auditingWithdraw?: number;
} }
/** 交易订单统计 Response */ /** 交易订单统计 Response */
export interface TradeOrderSummaryRespVO { export interface TradeOrderSummaryRespVO {
/** 支付订单商品数 */ orderPayCount?: number; // 支付订单商品数
orderPayCount?: number; orderPayPrice?: number; // 总支付金额，单位：分
/** 总支付金额，单位：分 */
orderPayPrice?: number;
} }
/** 订单量趋势统计 Response */ /** 订单量趋势统计 Response */
export interface TradeOrderTrend { export interface TradeOrderTrendRespVO {
/** 日期 */ date: string; // 日期
date: string; orderPayCount: number; // 订单数量
/** 订单数量 */ orderPayPrice: number; // 订单支付金额
orderPayCount: number;
/** 订单支付金额 */
orderPayPrice: number;
} }
} }
/** 时间参数需要格式化, 确保接口能识别 */
const formatDateParam = (params: MallTradeStatisticsApi.TradeTrendReq) => {
return {
times: [formatDate(params.times[0]), formatDate(params.times[1])],
} as MallTradeStatisticsApi.TradeTrendReq;
};
/** 查询交易统计 */ /** 查询交易统计 */
export function getTradeStatisticsSummary() { export function getTradeStatisticsSummary() {
return requestClient.get< return requestClient.get<
DataComparisonRespVO<MallTradeStatisticsApi.TradeSummary> DataComparisonRespVO<MallTradeStatisticsApi.TradeSummaryRespVO>
>('/statistics/trade/summary'); >('/statistics/trade/summary');
} }
/** 获得交易状况统计 */ /** 获得交易状况统计 */
export function getTradeStatisticsAnalyse( export function getTradeStatisticsAnalyse(
params: MallTradeStatisticsApi.TradeTrendReq, params: MallTradeStatisticsApi.TradeTrendReqVO,
) { ) {
return requestClient.get< return requestClient.get<
DataComparisonRespVO<MallTradeStatisticsApi.TradeTrendSummary> DataComparisonRespVO<MallTradeStatisticsApi.TradeTrendSummaryRespVO>
>('/statistics/trade/analyse', { params: formatDateParam(params) }); >('/statistics/trade/analyse', { params });
} }
/** 获得交易状况明细 */ /** 获得交易状况明细 */
export function getTradeStatisticsList( export function getTradeStatisticsList(params: any) {
params: MallTradeStatisticsApi.TradeTrendReq, return requestClient.get<MallTradeStatisticsApi.TradeTrendSummaryRespVO[]>(
) {
return requestClient.get<MallTradeStatisticsApi.TradeTrendSummary[]>(
'/statistics/trade/list', '/statistics/trade/list',
{ params: formatDateParam(params) }, { params },
); );
} }
/** 导出交易状况明细 */ /** 导出交易状况明细 */
export function exportTradeStatisticsExcel( export function exportTradeStatisticsExcel(params: any) {
params: MallTradeStatisticsApi.TradeTrendReq, return requestClient.download('/statistics/trade/export-excel', { params });
) {
return requestClient.download('/statistics/trade/export-excel', {
params: formatDateParam(params),
});
} }
/** 获得交易订单数量 */ /** 获得交易订单数量 */
export function getOrderCount() { export function getOrderCount() {
return requestClient.get<MallTradeStatisticsApi.TradeOrderCount>( return requestClient.get<MallTradeStatisticsApi.TradeOrderCountRespVO>(
'/statistics/trade/order-count', '/statistics/trade/order-count',
); );
} }
@@ -124,7 +102,7 @@ export function getOrderCountTrendComparison(
endTime: Date, endTime: Date,
) { ) {
return requestClient.get< return requestClient.get<
DataComparisonRespVO<MallTradeStatisticsApi.TradeOrderTrend>[] DataComparisonRespVO<MallTradeStatisticsApi.TradeOrderTrendRespVO>[]
>('/statistics/trade/order-count-trend', { >('/statistics/trade/order-count-trend', {
params: { params: {
type, type,

2
apps/web-ele/src/views/mall/statistics/trade/index.vue
View File

@@ -18,7 +18,7 @@ defineOptions({ name: 'TradeStatistics' });
const loading = ref(true); // 加载中 const loading = ref(true); // 加载中
const summary = const summary =
ref<DataComparisonRespVO<MallTradeStatisticsApi.TradeSummary>>(); // 交易统计数据 ref<DataComparisonRespVO<MallTradeStatisticsApi.TradeSummaryRespVO>>(); // 交易统计数据
/** 计算环比百分比 */ /** 计算环比百分比 */
function calculateRelativeRate(value?: number, reference?: number): string { function calculateRelativeRate(value?: number, reference?: number): string {

2
apps/web-ele/src/views/mall/statistics/trade/modules/trend-card.vue
View File

@@ -37,7 +37,7 @@ defineOptions({ name: 'TradeTrendCard' });
const trendLoading = ref(true); // 交易状态加载中 const trendLoading = ref(true); // 交易状态加载中
const exportLoading = ref(false); // 导出的加载中 const exportLoading = ref(false); // 导出的加载中
const trendSummary = const trendSummary =
ref<DataComparisonRespVO<MallTradeStatisticsApi.TradeTrendSummary>>(); // 交易状况统计数据 ref<DataComparisonRespVO<MallTradeStatisticsApi.TradeTrendSummaryRespVO>>(); // 交易状况统计数据
const searchTimes = ref<string[]>([]); const searchTimes = ref<string[]>([]);
const chartRef = ref<EchartsUIType>(); const chartRef = ref<EchartsUIType>();

2
apps/web-ele/src/views/mall/statistics/trade/modules/trend-chart-options.ts
View File

@@ -4,7 +4,7 @@ import { fenToYuan } from '@vben/utils';
/** 交易趋势折线图配置 */ /** 交易趋势折线图配置 */
export function getTradeTrendChartOptions( export function getTradeTrendChartOptions(
data: MallTradeStatisticsApi.TradeTrendSummary[], data: MallTradeStatisticsApi.TradeTrendSummaryRespVO[],
): any { ): any {
// 处理数据：将分转换为元 // 处理数据：将分转换为元
const processedData = data.map((item) => ({ const processedData = data.map((item) => ({