docs(coupon): 更新优惠券接口的注释文档
更新getPointRangesAPI和getCouponListAPI的JSDoc注释,简化积分范围描述并添加优惠券列表的详细字段说明
Showing
1 changed file
with
9 additions
and
6 deletions
| 1 | /* | 1 | /* |
| 2 | * @Date: 2024-01-01 00:00:00 | 2 | * @Date: 2024-01-01 00:00:00 |
| 3 | * @LastEditors: hookehuyr hookehuyr@gmail.com | 3 | * @LastEditors: hookehuyr hookehuyr@gmail.com |
| 4 | - * @LastEditTime: 2025-09-05 16:26:31 | 4 | + * @LastEditTime: 2025-09-08 12:10:33 |
| 5 | - * @FilePath: /lls_program/src/api/reward.js | 5 | + * @FilePath: /lls_program/src/api/coupon.js |
| 6 | * @Description: 优惠券相关接口 | 6 | * @Description: 优惠券相关接口 |
| 7 | */ | 7 | */ |
| 8 | import { fn, fetch } from './fn'; | 8 | import { fn, fetch } from './fn'; |
| ... | @@ -39,9 +39,7 @@ export const getCouponHomeAPI = (params) => fn(fetch.get(Api.COUPON_HOME, params | ... | @@ -39,9 +39,7 @@ export const getCouponHomeAPI = (params) => fn(fetch.get(Api.COUPON_HOME, params |
| 39 | * @returns {Object} response - 响应对象 | 39 | * @returns {Object} response - 响应对象 |
| 40 | * @returns {number} response.code - 响应状态码 | 40 | * @returns {number} response.code - 响应状态码 |
| 41 | * @returns {string} response.msg - 响应消息 | 41 | * @returns {string} response.msg - 响应消息 |
| 42 | - * @returns {Array} response.data[] - 响应数据 | 42 | + * @returns {Array} response.data[] - 响应数据 积分范围,例如:100-200 |
| 43 | - * @returns {string} response.data[].id - id | ||
| 44 | - * @returns {string} response.data[].points - 积分范围,例如:100-200 | ||
| 45 | */ | 43 | */ |
| 46 | export const getPointRangesAPI = (params) => fn(fetch.get(Api.POINT_RANGES, params)); | 44 | export const getPointRangesAPI = (params) => fn(fetch.get(Api.POINT_RANGES, params)); |
| 47 | 45 | ||
| ... | @@ -57,7 +55,12 @@ export const getPointRangesAPI = (params) => fn(fetch.get(Api.POINT_RANGES, para | ... | @@ -57,7 +55,12 @@ export const getPointRangesAPI = (params) => fn(fetch.get(Api.POINT_RANGES, para |
| 57 | * @returns {Object} response - 响应对象 | 55 | * @returns {Object} response - 响应对象 |
| 58 | * @returns {number} response.code - 响应状态码 | 56 | * @returns {number} response.code - 响应状态码 |
| 59 | * @returns {string} response.msg - 响应消息 | 57 | * @returns {string} response.msg - 响应消息 |
| 60 | - * @returns {Object} response.data - 响应数据 | 58 | + * @returns {Object} response.data[] - 响应数据 |
| 59 | + * @returns {string} response.data[].id - 优惠券ID | ||
| 60 | + * @returns {string} response.data[].title - 优惠券标题 | ||
| 61 | + * @returns {string} response.data[].thumbnail - 优惠券缩略图 | ||
| 62 | + * @returns {string} response.data[].points_cost - 需要多少积分兑换 | ||
| 63 | + * @returns {Boolean} response.data[].can_redeem - 是否可以兑换:true=可以,false=不可以 | ||
| 61 | */ | 64 | */ |
| 62 | export const getCouponListAPI = (params = {}) => fn(fetch.get(Api.COUPON_LIST, params)); | 65 | export const getCouponListAPI = (params = {}) => fn(fetch.get(Api.COUPON_LIST, params)); |
| 63 | 66 | ... | ... |
-
Please register or login to post a comment