Browse Source

docs(订单模块): 为订单API函数添加JSDoc注释

yz 1 month ago
parent
commit
428247fbba
1 changed files with 32 additions and 0 deletions
  1. 32 0
      src/api/order/order.js

+ 32 - 0
src/api/order/order.js

@@ -1,5 +1,12 @@
 import request from '@/router/axios';
 
+/**
+ * 获取订单列表
+ * @param {number} current - 当前页码
+ * @param {number} size - 每页大小
+ * @param {OrderQueryParams} params - 查询参数
+ * @returns {Promise<AxiosResponse<ApiResponse<PageResult<OrderItem>>>>} 订单列表响应
+ */
 export const getList = (current, size, params) => {
   return request({
     url: '/api/blade-factory/api/factory/order',
@@ -12,6 +19,11 @@ export const getList = (current, size, params) => {
   })
 }
 
+/**
+ * 新增订单
+ * @param {OrderForm} row - 订单表单数据
+ * @returns {Promise<AxiosResponse<ApiResponse<OrderItem>>>} 新增订单响应
+ */
 export const add = (row) => {
   return request({
     url: '/api/blade-factory/api/factory/order',
@@ -20,6 +32,11 @@ export const add = (row) => {
   })
 }
 
+/**
+ * 更新订单
+ * @param {OrderForm} row - 订单表单数据
+ * @returns {Promise<AxiosResponse<ApiResponse<OrderItem>>>} 更新订单响应
+ */
 export const update = (row) => {
   return request({
     url: '/api/blade-factory/api/factory/order',
@@ -28,6 +45,11 @@ export const update = (row) => {
   })
 }
 
+/**
+ * 删除订单
+ * @param {string} ids - 订单ID列表,多个ID用逗号分隔
+ * @returns {Promise<AxiosResponse<ApiResponse<boolean>>>} 删除订单响应
+ */
 export const remove = (ids) => {
   return request({
     url: '/api/blade-factory/api/factory/order/remove',
@@ -38,6 +60,11 @@ export const remove = (ids) => {
   })
 }
 
+/**
+ * 获取订单详情
+ * @param {string|number} id - 订单ID
+ * @returns {Promise<AxiosResponse<ApiResponse<OrderItem>>>} 订单详情响应
+ */
 export const getDetail = (id) => {
   return request({
     url: `/api/blade-factory/api/factory/order/${id}`,
@@ -45,6 +72,11 @@ export const getDetail = (id) => {
   })
 }
 
+/**
+ * 获取客户地址列表
+ * @param {string} customerCode - 客户编码
+ * @returns {Promise<AxiosResponse<ApiResponse<PageResult<CustomerAddressOption>>>>} 客户地址列表响应
+ */
 export const getCustomerAddressList = (customerCode) => {
   return request({
     url: '/api/blade-factory/api/factory/address',