Browse Source

refactor(api): 统一接口返回类型为AxiosResponse并完善类型定义

yz 1 month ago
parent
commit
868233c9d9

+ 4 - 4
src/api/announcement/category.js

@@ -54,7 +54,7 @@ import request from '@/router/axios';
 
 /**
  * 获取分类列表
- * @returns {Promise<ApiResponse<Array<CategoryItem>>>} 分类列表响应
+ * @returns {Promise<AxiosResponse<Array<CategoryItem>>>} 分类列表响应
  */
 export const getCategoryList = () => {
   return request({
@@ -74,7 +74,7 @@ export const getCategoryList = () => {
  * @param {string} params.orgName - 组织名称
  * @param {string} [params.remark=''] - 备注
  * @param {number} [params.sortOrder=0] - 排序
- * @returns {Promise<ApiResponse<null>>} 操作结果
+ * @returns {Promise<AxiosResponse<null>>} 操作结果
  */
 export const addCategory = (params) => {
   return request({
@@ -94,7 +94,7 @@ export const addCategory = (params) => {
  * @param {string} params.name - 分类名称
  * @param {string} [params.remark] - 备注
  * @param {number} [params.sortOrder] - 排序
- * @returns {Promise<ApiResponse<null>>} 操作结果
+ * @returns {Promise<AxiosResponse<null>>} 操作结果
  */
 export const updateCategory = (params) => {
   return request({
@@ -107,7 +107,7 @@ export const updateCategory = (params) => {
 /**
  * 删除分类
  * @param {string|number} ids - 分类ID,多个用逗号分隔
- * @returns {Promise<ApiResponse<null>>} 操作结果
+ * @returns {Promise<AxiosResponse<null>>} 操作结果
  */
 export const removeCategory = (ids) => {
   return request({

+ 17 - 2
src/api/announcement/index.js

@@ -75,6 +75,11 @@ export const getList = (current, size, params = {}) => {
   });
 };
 
+/**
+ * 新增公告
+ * @param {NoticeFormData} row - 公告表单数据
+ * @returns {Promise<AxiosResponse<boolean>>} 操作结果
+ */
 export const add = (row) => {
   return request({
     url: '/api/blade-factory/api/factory/notice/add',
@@ -83,6 +88,11 @@ export const add = (row) => {
   });
 };
 
+/**
+ * 修改公告
+ * @param {NoticeFormData} row - 公告表单数据
+ * @returns {Promise<AxiosResponse<boolean>>} 操作结果
+ */
 export const update = (row) => {
   return request({
     url: '/api/blade-factory/api/factory/notice/update',
@@ -91,6 +101,11 @@ export const update = (row) => {
   });
 };
 
+/**
+ * 获取公告详情
+ * @param {string} id - 公告ID
+ * @returns {Promise<AxiosResponse<NoticeRecord>>} 公告详情
+ */
 export const getAnnouncement = (id) => {
   return request({
     url: '/api/blade-factory/api/factory/notice/detail',
@@ -103,7 +118,7 @@ export const getAnnouncement = (id) => {
 
 /**
  * 获取经销商列表(保留兼容性)
- * @returns {Promise<any>}
+ * @returns {Promise<AxiosResponse<Array<{id: string, name: string}>>>}
  */
 export const getDealerList = () => {
   return request({
@@ -114,7 +129,7 @@ export const getDealerList = () => {
 
 /**
  * 获取品牌列表(保留兼容性)
- * @returns {Promise<any>}
+ * @returns {Promise<AxiosResponse<Array<{id: string, name: string}>>>}
  */
 export const getBrandList = () => {
   return request({

+ 1 - 1
src/api/common/index.js

@@ -123,7 +123,7 @@ export const getCustomerList = async (current = 1, size = 10, params = {}) => {
 /**
  * 获取客户档案详情
  * @param {string} customerId - 客户ID
- * @returns {Promise<ApiResponse<CustomerItem>>} 客户档案详情响应
+ * @returns {Promise<AxiosResponse<CustomerItem>>} 客户档案详情响应
  */
 export const getCustomerDetail = async (customerId) => {
   return request({

+ 2 - 2
src/api/complaint/index.js

@@ -142,7 +142,7 @@ export const update = (row) => {
 /**
  * 删除投诉
  * @param {string} ids - 投诉ID列表,多个用逗号分隔
- * @returns {Promise<ApiResponse<null>>} 操作结果
+ * @returns {Promise<AxiosResponse<null>>} 操作结果
  */
 export const remove = (ids) => {
   return request({
@@ -157,7 +157,7 @@ export const remove = (ids) => {
 /**
  * 获取投诉详情
  * @param {string} complaintId - 投诉ID
- * @returns {Promise<ApiResponse<ComplaintRecord>>} 投诉详情
+ * @returns {Promise<AxiosResponse<ComplaintRecord>>} 投诉详情
  */
 export const getDetail = (complaintId) => {
   return request({

+ 2 - 2
src/api/dealer/inventory.js

@@ -65,7 +65,7 @@ import request from '@/router/axios'
 /**
  * 获取经销商库存列表
  * @param {InventoryListParams} params - 查询参数
- * @returns {Promise<AxiosResponse<ApiResponse<PageResponse>>>} 返回分页数据
+ * @returns {Promise<AxiosResponse<{records: DealerInventoryRecord[], total: number, size: number, current: number}>>} 返回分页数据
  */
 export const getInventoryList = (params) => {
   return request({
@@ -82,7 +82,7 @@ export const getInventoryList = (params) => {
 /**
  * 获取经销商库存详情
  * @param {string} inventoryId - 库存记录ID
- * @returns {Promise<AxiosResponse<ApiResponse<DealerInventoryRecord>>>} 返回库存详情
+ * @returns {Promise<AxiosResponse<DealerInventoryRecord>>} 返回库存详情
  */
 export const getInventoryDetail = (inventoryId) => {
   return request({

+ 3 - 3
src/api/forecast/index.js

@@ -101,10 +101,10 @@ import request from '@/router/axios'
  * @param {number} [current=1] - 当前页码
  * @param {number} [size=10] - 每页数量
  * @param {ForecastQueryParams} [params={}] - 查询参数
- * @returns {Promise<AxiosResponse<ForecastPageResponse>>} 预测申报列表响应
- * @description 获取经销商销售预测申报列表,支持多条件查询和分页
+ * @returns {Promise<AxiosResponse<{records: ForecastItem[], total: number, size: number, current: number}>>} 分页查询结果响应
+ * @description 分页查询经销商销售预测申报列表,支持多种筛选条件
  * @example
- * // 获取第一页10条数据
+ * // 基础查询
  * const result = await getForecastList(1, 10)
  *
  * // 按年月查询

+ 3 - 3
src/api/shipment/index.js

@@ -62,7 +62,7 @@ import request from '@/router/axios'
  * @param {string} [params.orderCode] - 订单编号
  * @param {string} [params.carrierName] - 承运商名称
  * @param {number} [params.shipmentStatus] - 发货状态
- * @returns {Promise<AxiosResponse<{records: OrderShipmentItem[], total: number}>>}
+ * @returns {Promise<AxiosResponse<{records: OrderShipmentItem[], total: number, size: number, current: number}>>}
  */
 export const getOrderShipmentList = (params) => {
   return request({
@@ -80,7 +80,7 @@ export const getOrderShipmentList = (params) => {
  * @param {string} [params.shipmentNo] - 发货单号
  * @param {string} [params.itemCode] - 物料编码
  * @param {string} [params.itemName] - 物料名称
- * @returns {Promise<AxiosResponse<{records: ShipmentItemDetail[], total: number}>>}
+ * @returns {Promise<AxiosResponse<{records: ShipmentItemDetail[], total: number, size: number, current: number}>>}
  */
 export const getShipmentItemList = (params) => {
   return request({
@@ -98,7 +98,7 @@ export const getShipmentItemList = (params) => {
  * @param {string} [params.shipmentNo] - 发货单号
  * @param {string} [params.trackingNo] - 运单号
  * @param {string} [params.trackingStatus] - 跟踪状态
- * @returns {Promise<AxiosResponse<{records: ShipmentTrackingInfo[], total: number}>>}
+ * @returns {Promise<AxiosResponse<{records: ShipmentTrackingInfo[], total: number, size: number, current: number}>>}
  */
 export const getShipmentTrackingList = (params) => {
   return request({

+ 5 - 5
src/api/survey/survey.js

@@ -74,11 +74,11 @@ import request from '@/router/axios';
  */
 
 /**
- * 调查问卷分页查询
+ * 获取调查问卷列表
  * @param {number} current - 当前页码
  * @param {number} size - 每页大小
  * @param {SurveyQueryParams} [params] - 查询参数
- * @returns {Promise<ApiResponse<PageResult<SurveyItem>>>} 分页查询结果
+ * @returns {Promise<AxiosResponse<{records: SurveyItem[], total: number, size: number, current: number}>>} 分页查询结果
  */
 export const getList = (current, size, params) => {
   return request({
@@ -95,7 +95,7 @@ export const getList = (current, size, params) => {
 /**
  * 新增调查问卷
  * @param {SurveyForm} row - 问卷表单数据
- * @returns {Promise<ApiResponse<boolean>>} 新增结果
+ * @returns {Promise<AxiosResponse<boolean>>} 新增结果
  */
 export const add = (row) => {
   return request({
@@ -108,7 +108,7 @@ export const add = (row) => {
 /**
  * 修改调查问卷
  * @param {SurveyForm} row - 问卷表单数据
- * @returns {Promise<ApiResponse<boolean>>} 修改结果
+ * @returns {Promise<AxiosResponse<boolean>>} 修改结果
  */
 export const update = (row) => {
   return request({
@@ -121,7 +121,7 @@ export const update = (row) => {
 /**
  * 获取调查问卷详情
  * @param {string|number} surveyId - 问卷ID
- * @returns {Promise<ApiResponse<SurveyItem>>} 问卷详情
+ * @returns {Promise<AxiosResponse<SurveyItem>>} 问卷详情
  */
 export const getDetail = (surveyId) => {
   return request({