Browse Source

docs(api): 完善API函数注释并移除冗余注释

- 为多个API函数添加详细的参数类型说明
- 移除无意义的@returns标签
- 修正getUserTreatyApi的URL路径格式
- 新增loginApi、yesterdayOrderApi和getCartInfoApi的注释
master
wei 1 week ago
parent
commit
053c1310d7
  1. 69
      libs/api/index.js

69
libs/api/index.js

@ -83,7 +83,6 @@ export function getProductsApi(params = {}) {
/**
* 获取用户仓库
* @param {{warehouseid: unknow}} params
* @returns
*/
export function getmyareaApi(params = {}) {
// ajax('get', '/area/getMyArea.do?warehouseid='+warehouseid, '', success)
@ -116,7 +115,6 @@ export function getSystemSettingApi(params = {}) {
/**
* 修改默认收货地址
* @param {*} params
* @returns
*/
export function editDefaultAddressApi(params = {}) {
return request({
@ -130,7 +128,6 @@ export function editDefaultAddressApi(params = {}) {
/**
* 获取广播
* @param {{warehouseId: unknown}} data
* @returns
*/
export function getBroadcastApi(data) {
return request({
@ -141,15 +138,16 @@ export function getBroadcastApi(data) {
});
}
// 我的订单 (DFK:待付款。DFH:待发货。CANCEL取消。DSH待收货。TH退货),可以为空,为空时查询所有订单的状态。
// service.myOrders = function (warehouseid, addrId, status, pageNum, pageSize, success) {
// ajax('get', '/order/list.do?warehouseid=' + warehouseid + '&addrId=' + addrId + '&orderNo=' + "" + '&status=' + status + '&pageNum=' + pageNum + '&pageSize=' + pageSize, '', success)
// }
/**
* 我的订单
* @description DFK待付款DFH待发货CANCEL取消DSH待收货TH退货可以为空为空时查询所有订单的状态
* @param {*} params
* @param {{
* warehouseid: unknow,
* addrId: unknow,
* status: unknow,
* pageNum: unknow,
* pageSize: unknow
* }} params
*/
export function myOrdersApi(params = {}) {
return request({
@ -175,7 +173,6 @@ export function getUserInfoApi(params = {}) {
/**
* 查询廉洁协议
* @param {*} params
* @returns
*/
export function getHonestApi(params = {}) {
return request({
@ -189,7 +186,6 @@ export function getHonestApi(params = {}) {
/**
* 获取廉洁协议甲方公章图片
* @param {{companyName: string}} params
* @returns
*/
export function sealImgApi(params = {}) {
return request({
@ -216,7 +212,6 @@ export function sealImgApi(params = {}) {
* createTime: String
* image: String
* }} data
* @returns
*/
export function addHonestApi(data = {}) {
return request({
@ -230,7 +225,6 @@ export function addHonestApi(data = {}) {
/**
* 获取微信用户 openid
* @param {{code: string}} data
* @returns
*/
export function xcxWxLoginApi(data = {}) {
return request({
@ -258,14 +252,59 @@ export function getUserByXcxAPPOpenIdApi(data) {
/**
* 获取协议
* @param {*} data
* @returns
*/
export function getUserTreatyApi(data) {
return request({
errorMessage: "用户协议",
url: "userTreaty/getUserTreaty.do",
url: "/userTreaty/getUserTreaty.do",
method: "GET",
data,
header: { "content-type": "application/x-www-form-urlencoded;charset=utf-8" },
});
}
// 登陆
// service.login = function (data, success) {
// data.rememberMe = true
// ajax('post', '/user/login.do', data, success, "application/x-www-form-urlencoded")
// }
/**
* 登录
* @param {*} data
*/
export function loginApi(data = {}) {
return request({
// errorMessage: "登录",
method: "POST",
header: {
"content-type": "application/x-www-form-urlencoded;charset=utf-8",
},
data,
url: "/user/login.do",
});
}
/**
* 获取昨日下单订单号
*/
export function yesterdayOrderApi() {
return request({
errorMessage: "昨日订单",
method: "GET",
url: "/order/yesterdayOrder.do",
});
}
// module.exports.getCartInfo = function (postData, success) {
// request('/cart/list.do', 'GET', postData, success)
// };
export function getCartInfoApi(params = {}) {
return request({
errorMessage: "购物车",
method: "GET",
params,
url: "/cart/list.do",
});
}
Loading…
Cancel
Save