From 54cf3faf5c64f2973fac825fb63c4a8c27a3ed08 Mon Sep 17 00:00:00 2001 From: wangzhuo <3186725297@qq.com> Date: Tue, 17 Dec 2024 22:15:41 +0800 Subject: [PATCH] wangzhuo --- src/api/flashSession.js | 117 ++++++++++++++++++++++++++++++------ src/api/homeAdvertise.js | 125 +++++++++++++++++++++++++++++++++------ src/api/homeBrand.js | 100 ++++++++++++++++++++++++++----- src/api/homeSubject.js | 100 ++++++++++++++++++++++++++----- src/api/hotProduct.js | 100 ++++++++++++++++++++++++++----- 5 files changed, 461 insertions(+), 81 deletions(-) diff --git a/src/api/flashSession.js b/src/api/flashSession.js index 2349f89..1ec29bb 100644 --- a/src/api/flashSession.js +++ b/src/api/flashSession.js @@ -1,48 +1,131 @@ +// 导入封装的 HTTP 请求工具,用于与后端 API 进行通信 import request from '@/utils/request' +/** + * fetchList - 获取限时购场次列表 + * + * 通过 GET 请求获取限时购场次的列表数据,支持查询参数筛选结果。 + * + * @param {Object} params - 查询参数,例如分页信息等。 + * 示例:{ pageNum: 1, pageSize: 10 } + * @returns {Promise} - 返回一个 Promise 对象,包含接口返回的数据。 + * + * 用法示例: + * fetchList({ pageNum: 1, pageSize: 10 }).then(response => { + * console.log(response); + * }); + */ export function fetchList(params) { return request({ - url: '/flashSession/list', - method: 'get', - params: params + url: '/flashSession/list', // 接口URL:获取限时购场次列表 + method: 'get', // 请求方法:GET + params: params // 查询参数,通过 URL 传递 }) } +/** + * fetchSelectList - 获取可选择的限时购场次列表 + * + * 通过 GET 请求获取简化版的限时购场次数据,用于下拉选择框等场景。 + * + * @param {Object} params - 查询参数,例如过滤条件等。 + * 示例:{ flashId: 1 } + * @returns {Promise} - 返回一个 Promise 对象,包含接口返回的数据。 + * + * 用法示例: + * fetchSelectList({ flashId: 1 }).then(response => { + * console.log(response); + * }); + */ export function fetchSelectList(params) { return request({ - url: '/flashSession/selectList', - method: 'get', - params: params + url: '/flashSession/selectList', // 接口URL:获取可选的场次列表 + method: 'get', // 请求方法:GET + params: params // 查询参数 }) } +/** + * updateStatus - 更新指定场次的状态 + * + * 通过 POST 请求更新场次的状态,例如启用或禁用状态。 + * + * @param {number|string} id - 限时购场次的唯一标识ID。 + * @param {Object} params - 状态参数,例如 { status: 1 }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateStatus(1, { status: 1 }).then(response => { + * console.log(response); + * }); + */ export function updateStatus(id, params) { return request({ - url: '/flashSession/update/status/' + id, - method: 'post', - params: params + url: '/flashSession/update/status/' + id, // 接口URL:更新场次状态 + method: 'post', // 请求方法:POST + params: params // 状态参数,通过 URL 查询字符串传递 }) } +/** + * deleteSession - 删除指定的限时购场次 + * + * 通过 POST 请求删除指定 ID 的限时购场次。 + * + * @param {number|string} id - 限时购场次的唯一标识ID。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * deleteSession(1).then(response => { + * console.log(response); + * }); + */ export function deleteSession(id) { return request({ - url: '/flashSession/delete/' + id, - method: 'post' + url: '/flashSession/delete/' + id, // 接口URL:删除场次 + method: 'post' // 请求方法:POST }) } +/** + * createSession - 创建新的限时购场次 + * + * 通过 POST 请求提交新的场次数据,创建限时购场次。 + * + * @param {Object} data - 场次的详细数据,例如 { name: '上午场', startTime: '08:00', endTime: '12:00' }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * createSession({ name: '上午场', startTime: '08:00', endTime: '12:00' }).then(response => { + * console.log(response); + * }); + */ export function createSession(data) { return request({ - url: '/flashSession/create', - method: 'post', - data: data + url: '/flashSession/create', // 接口URL:创建场次 + method: 'post', // 请求方法:POST + data: data // 请求体,包含场次数据 }) } +/** + * updateSession - 更新指定的限时购场次数据 + * + * 通过 POST 请求提交更新后的场次数据,更新指定 ID 的场次信息。 + * + * @param {number|string} id - 限时购场次的唯一标识ID。 + * @param {Object} data - 更新后的场次数据,例如 { name: '下午场', startTime: '13:00', endTime: '18:00' }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateSession(1, { name: '下午场', startTime: '13:00', endTime: '18:00' }).then(response => { + * console.log(response); + * }); + */ export function updateSession(id, data) { return request({ - url: '/flashSession/update/' + id, - method: 'post', - data: data + url: '/flashSession/update/' + id, // 接口URL:更新场次信息 + method: 'post', // 请求方法:POST + data: data // 请求体,包含更新数据 }) } diff --git a/src/api/homeAdvertise.js b/src/api/homeAdvertise.js index 6cc3a02..7307dfd 100644 --- a/src/api/homeAdvertise.js +++ b/src/api/homeAdvertise.js @@ -1,43 +1,130 @@ +// 导入封装的 HTTP 请求工具,用于与后端 API 进行通信 import request from '@/utils/request' + +/** + * fetchList - 获取首页广告列表 + * + * 通过 GET 请求获取首页广告列表,支持查询参数进行筛选或分页。 + * + * @param {Object} params - 查询参数,例如分页和过滤条件。 + * 示例:{ pageNum: 1, pageSize: 10 } + * @returns {Promise} - 返回一个 Promise 对象,包含接口返回的数据。 + * + * 用法示例: + * fetchList({ pageNum: 1, pageSize: 10 }).then(response => { + * console.log(response); + * }); + */ export function fetchList(params) { return request({ - url:'/home/advertise/list', - method:'get', - params:params + url: '/home/advertise/list', // 接口URL:获取首页广告列表 + method: 'get', // 请求方法:GET + params: params // 查询参数,通过 URL 传递 }) } -export function updateStatus(id,params) { + +/** + * updateStatus - 更新指定广告的状态 + * + * 通过 POST 请求更新首页广告的状态(启用/禁用)。 + * + * @param {number|string} id - 广告的唯一标识ID。 + * @param {Object} params - 状态参数,例如 { status: 1 }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateStatus(1, { status: 1 }).then(response => { + * console.log(response); + * }); + */ +export function updateStatus(id, params) { return request({ - url:'/home/advertise/update/status/'+id, - method:'post', - params:params + url: '/home/advertise/update/status/' + id, // 接口URL:更新广告状态 + method: 'post', // 请求方法:POST + params: params // 状态参数,通过 URL 查询字符串传递 }) } + +/** + * deleteHomeAdvertise - 批量删除首页广告 + * + * 通过 POST 请求删除多个广告记录。 + * + * @param {Array} data - 广告ID数组,例如 [1, 2, 3]。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * deleteHomeAdvertise([1, 2, 3]).then(response => { + * console.log(response); + * }); + */ export function deleteHomeAdvertise(data) { return request({ - url:'/home/advertise/delete', - method:'post', - data:data + url: '/home/advertise/delete', // 接口URL:批量删除广告 + method: 'post', // 请求方法:POST + data: data // 请求体,包含广告ID数组 }) } + +/** + * createHomeAdvertise - 创建新的首页广告 + * + * 通过 POST 请求提交新的广告数据,创建首页广告。 + * + * @param {Object} data - 广告的详细数据,例如 { name: '新广告', type: 1, pic: 'url' }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * createHomeAdvertise({ name: '新广告', type: 1 }).then(response => { + * console.log(response); + * }); + */ export function createHomeAdvertise(data) { return request({ - url:'/home/advertise/create', - method:'post', - data:data + url: '/home/advertise/create', // 接口URL:创建广告 + method: 'post', // 请求方法:POST + data: data // 请求体,包含广告数据 }) } + +/** + * getHomeAdvertise - 获取指定广告详情 + * + * 通过 GET 请求获取单个广告的详细信息。 + * + * @param {number|string} id - 广告的唯一标识ID。 + * @returns {Promise} - 返回一个 Promise 对象,包含广告详情数据。 + * + * 用法示例: + * getHomeAdvertise(1).then(response => { + * console.log(response); + * }); + */ export function getHomeAdvertise(id) { return request({ - url:'/home/advertise/'+id, - method:'get', + url: '/home/advertise/' + id, // 接口URL:获取广告详情 + method: 'get' // 请求方法:GET }) } -export function updateHomeAdvertise(id,data) { +/** + * updateHomeAdvertise - 更新指定广告的信息 + * + * 通过 POST 请求提交更新后的广告数据,更新指定广告的信息。 + * + * @param {number|string} id - 广告的唯一标识ID。 + * @param {Object} data - 更新后的广告数据,例如 { name: '更新广告', type: 2 }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateHomeAdvertise(1, { name: '更新广告', type: 2 }).then(response => { + * console.log(response); + * }); + */ +export function updateHomeAdvertise(id, data) { return request({ - url:'/home/advertise/update/'+id, - method:'post', - data:data + url: '/home/advertise/update/' + id, // 接口URL:更新广告信息 + method: 'post', // 请求方法:POST + data: data // 请求体,包含更新后的广告数据 }) } diff --git a/src/api/homeBrand.js b/src/api/homeBrand.js index abd4452..c457562 100644 --- a/src/api/homeBrand.js +++ b/src/api/homeBrand.js @@ -1,40 +1,110 @@ +// 导入封装的 HTTP 请求工具,用于与后端 API 进行通信 import request from '@/utils/request' + +/** + * fetchList - 获取首页品牌列表 + * + * 通过 GET 请求获取首页品牌列表,支持分页和条件筛选。 + * + * @param {Object} params - 查询参数,例如分页和筛选条件。 + * 示例:{ pageNum: 1, pageSize: 10, keyword: '品牌名' } + * @returns {Promise} - 返回一个 Promise 对象,包含接口返回的数据。 + * + * 用法示例: + * fetchList({ pageNum: 1, pageSize: 10 }).then(response => { + * console.log(response); + * }); + */ export function fetchList(params) { return request({ - url:'/home/brand/list', - method:'get', - params:params + url: '/home/brand/list', // 接口URL:获取品牌列表 + method: 'get', // 请求方法:GET + params: params // 查询参数,通过 URL 传递 }) } +/** + * updateRecommendStatus - 批量更新品牌推荐状态 + * + * 通过 POST 请求批量更新品牌的推荐状态(如是否推荐)。 + * + * @param {Array} data - 推荐状态数据,包含品牌ID数组和推荐状态。 + * 示例:{ ids: [1, 2, 3], recommendStatus: 1 } + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateRecommendStatus({ ids: [1, 2], recommendStatus: 1 }).then(response => { + * console.log(response); + * }); + */ export function updateRecommendStatus(data) { return request({ - url:'/home/brand/update/recommendStatus', - method:'post', - data:data + url: '/home/brand/update/recommendStatus', // 接口URL:更新推荐状态 + method: 'post', // 请求方法:POST + data: data // 请求体,包含品牌ID和状态 }) } +/** + * deleteHomeBrand - 批量删除首页品牌 + * + * 通过 POST 请求删除多个品牌记录。 + * + * @param {Array} data - 品牌ID数组,例如 [1, 2, 3]。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * deleteHomeBrand([1, 2, 3]).then(response => { + * console.log(response); + * }); + */ export function deleteHomeBrand(data) { return request({ - url:'/home/brand/delete', - method:'post', - data:data + url: '/home/brand/delete', // 接口URL:批量删除品牌 + method: 'post', // 请求方法:POST + data: data // 请求体,包含品牌ID数组 }) } +/** + * createHomeBrand - 创建新的首页品牌 + * + * 通过 POST 请求提交新的品牌数据,创建首页品牌。 + * + * @param {Object} data - 品牌的详细数据,例如 { brandId: 1, brandName: '品牌名', sort: 0 }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * createHomeBrand({ brandId: 1, brandName: '新品牌', sort: 1 }).then(response => { + * console.log(response); + * }); + */ export function createHomeBrand(data) { return request({ - url:'/home/brand/create', - method:'post', - data:data + url: '/home/brand/create', // 接口URL:创建品牌 + method: 'post', // 请求方法:POST + data: data // 请求体,包含品牌数据 }) } +/** + * updateHomeBrandSort - 更新品牌的排序值 + * + * 通过 POST 请求更新指定品牌的排序值。 + * + * @param {Object} params - 排序参数,包含品牌ID和新的排序值。 + * 示例:{ id: 1, sort: 10 } + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateHomeBrandSort({ id: 1, sort: 10 }).then(response => { + * console.log(response); + * }); + */ export function updateHomeBrandSort(params) { return request({ - url:'/home/brand/update/sort/'+params.id, - method:'post', - params:params + url: '/home/brand/update/sort/' + params.id, // 接口URL:更新品牌排序 + method: 'post', // 请求方法:POST + params: params // 排序参数,通过 URL 查询字符串传递 }) } diff --git a/src/api/homeSubject.js b/src/api/homeSubject.js index 7588922..c8e2efe 100644 --- a/src/api/homeSubject.js +++ b/src/api/homeSubject.js @@ -1,40 +1,110 @@ +// 导入封装的 HTTP 请求工具,用于与后端 API 进行通信 import request from '@/utils/request' + +/** + * fetchList - 获取首页推荐专题列表 + * + * 通过 GET 请求获取首页推荐专题列表,支持分页和条件筛选。 + * + * @param {Object} params - 查询参数,例如分页和筛选条件。 + * 示例:{ pageNum: 1, pageSize: 10, keyword: '专题名' } + * @returns {Promise} - 返回一个 Promise 对象,包含接口返回的数据。 + * + * 用法示例: + * fetchList({ pageNum: 1, pageSize: 10 }).then(response => { + * console.log(response); + * }); + */ export function fetchList(params) { return request({ - url:'/home/recommendSubject/list', - method:'get', - params:params + url: '/home/recommendSubject/list', // 接口URL:获取推荐专题列表 + method: 'get', // 请求方法:GET + params: params // 查询参数,通过 URL 传递 }) } +/** + * updateRecommendStatus - 批量更新推荐专题的推荐状态 + * + * 通过 POST 请求批量更新首页推荐专题的推荐状态。 + * + * @param {Object} data - 推荐状态数据,包含专题ID数组和推荐状态。 + * 示例:{ ids: [1, 2, 3], recommendStatus: 1 } + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateRecommendStatus({ ids: [1, 2, 3], recommendStatus: 1 }).then(response => { + * console.log(response); + * }); + */ export function updateRecommendStatus(data) { return request({ - url:'/home/recommendSubject/update/recommendStatus', - method:'post', - data:data + url: '/home/recommendSubject/update/recommendStatus', // 接口URL:更新推荐状态 + method: 'post', // 请求方法:POST + data: data // 请求体,包含专题ID和推荐状态 }) } +/** + * deleteHomeSubject - 批量删除推荐专题 + * + * 通过 POST 请求删除多个推荐专题。 + * + * @param {Array} data - 专题ID数组,例如 [1, 2, 3]。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * deleteHomeSubject([1, 2, 3]).then(response => { + * console.log(response); + * }); + */ export function deleteHomeSubject(data) { return request({ - url:'/home/recommendSubject/delete', - method:'post', - data:data + url: '/home/recommendSubject/delete', // 接口URL:批量删除专题 + method: 'post', // 请求方法:POST + data: data // 请求体,包含专题ID数组 }) } +/** + * createHomeSubject - 创建新的首页推荐专题 + * + * 通过 POST 请求提交新的专题数据,创建首页推荐专题。 + * + * @param {Object} data - 推荐专题的详细数据,例如 { subjectId: 1, subjectName: '专题名', sort: 0 }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * createHomeSubject({ subjectId: 1, subjectName: '新专题', sort: 1 }).then(response => { + * console.log(response); + * }); + */ export function createHomeSubject(data) { return request({ - url:'/home/recommendSubject/create', - method:'post', - data:data + url: '/home/recommendSubject/create', // 接口URL:创建推荐专题 + method: 'post', // 请求方法:POST + data: data // 请求体,包含推荐专题数据 }) } +/** + * updateHomeSubjectSort - 更新推荐专题的排序值 + * + * 通过 POST 请求更新指定推荐专题的排序值。 + * + * @param {Object} params - 排序参数,包含专题ID和新的排序值。 + * 示例:{ id: 1, sort: 10 } + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateHomeSubjectSort({ id: 1, sort: 10 }).then(response => { + * console.log(response); + * }); + */ export function updateHomeSubjectSort(params) { return request({ - url:'/home/recommendSubject/update/sort/'+params.id, - method:'post', - params:params + url: '/home/recommendSubject/update/sort/' + params.id, // 接口URL:更新专题排序 + method: 'post', // 请求方法:POST + params: params // 排序参数,通过 URL 查询字符串传递 }) } diff --git a/src/api/hotProduct.js b/src/api/hotProduct.js index 4b5cead..483f410 100644 --- a/src/api/hotProduct.js +++ b/src/api/hotProduct.js @@ -1,40 +1,110 @@ +// 导入封装的 HTTP 请求工具,用于与后端 API 进行通信 import request from '@/utils/request' + +/** + * fetchList - 获取首页推荐商品列表 + * + * 通过 GET 请求获取首页推荐商品列表,支持分页和条件筛选。 + * + * @param {Object} params - 查询参数,例如分页和筛选条件。 + * 示例:{ pageNum: 1, pageSize: 10, keyword: '商品名' } + * @returns {Promise} - 返回一个 Promise 对象,包含接口返回的数据。 + * + * 用法示例: + * fetchList({ pageNum: 1, pageSize: 10 }).then(response => { + * console.log(response); + * }); + */ export function fetchList(params) { return request({ - url:'/home/recommendProduct/list', - method:'get', - params:params + url: '/home/recommendProduct/list', // 接口URL:获取推荐商品列表 + method: 'get', // 请求方法:GET + params: params // 查询参数,通过 URL 传递 }) } +/** + * updateRecommendStatus - 批量更新推荐商品的推荐状态 + * + * 通过 POST 请求批量更新首页推荐商品的推荐状态。 + * + * @param {Object} data - 推荐状态数据,包含商品ID数组和推荐状态。 + * 示例:{ ids: [1, 2, 3], recommendStatus: 1 } + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateRecommendStatus({ ids: [1, 2, 3], recommendStatus: 1 }).then(response => { + * console.log(response); + * }); + */ export function updateRecommendStatus(data) { return request({ - url:'/home/recommendProduct/update/recommendStatus', - method:'post', - data:data + url: '/home/recommendProduct/update/recommendStatus', // 接口URL:更新推荐状态 + method: 'post', // 请求方法:POST + data: data // 请求体,包含商品ID和推荐状态 }) } +/** + * deleteHotProduct - 批量删除推荐商品 + * + * 通过 POST 请求删除多个推荐商品。 + * + * @param {Array} data - 商品ID数组,例如 [1, 2, 3]。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * deleteHotProduct([1, 2, 3]).then(response => { + * console.log(response); + * }); + */ export function deleteHotProduct(data) { return request({ - url:'/home/recommendProduct/delete', - method:'post', - data:data + url: '/home/recommendProduct/delete', // 接口URL:批量删除推荐商品 + method: 'post', // 请求方法:POST + data: data // 请求体,包含商品ID数组 }) } +/** + * createHotProduct - 创建新的首页推荐商品 + * + * 通过 POST 请求提交新的商品数据,创建首页推荐商品。 + * + * @param {Object} data - 商品的详细数据,例如 { productId: 1, productName: '商品名', sort: 0 }。 + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * createHotProduct({ productId: 1, productName: '新商品', sort: 1 }).then(response => { + * console.log(response); + * }); + */ export function createHotProduct(data) { return request({ - url:'/home/recommendProduct/create', - method:'post', - data:data + url: '/home/recommendProduct/create', // 接口URL:创建推荐商品 + method: 'post', // 请求方法:POST + data: data // 请求体,包含商品数据 }) } +/** + * updateHotProductSort - 更新推荐商品的排序值 + * + * 通过 POST 请求更新指定推荐商品的排序值。 + * + * @param {Object} params - 排序参数,包含商品ID和新的排序值。 + * 示例:{ id: 1, sort: 10 } + * @returns {Promise} - 返回一个 Promise 对象,包含操作结果。 + * + * 用法示例: + * updateHotProductSort({ id: 1, sort: 10 }).then(response => { + * console.log(response); + * }); + */ export function updateHotProductSort(params) { return request({ - url:'/home/recommendProduct/update/sort/'+params.id, - method:'post', - params:params + url: '/home/recommendProduct/update/sort/' + params.id, // 接口URL:更新商品排序 + method: 'post', // 请求方法:POST + params: params // 排序参数,通过 URL 查询字符串传递 }) }