Blame view

绿纤uni-app/apis/modules/README-project.md 2.91 KB
29608708   李宇   增加unia-app和html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
  # 品项API模块使用说明
  
  ## 概述
  `project.js` 模块封装了品项相关的所有API接口,包括获取品项列表、创建、更新、删除等操作。
  
  ## API接口
  
  ### 1. 获取品项列表
  ```javascript
  import projectApi from '@/apis/modules/project.js'
  
  // 基本用法
  const result = await projectApi.getProjectList({
      currentPage: 1,
      pageSize: 20
  });
  ```
  
  ### 2. 获取品项选项(推荐用于下拉选择)
  ```javascript
  // 获取所有品项选项
  const options = await projectApi.getProjectOptions();
  
  // 带搜索参数的选项
  const options = await projectApi.getProjectOptions({
      currentPage: 1,
      pageSize: 1000,
      xmmc: '搜索关键词'
  });
  ```
  
  ### 3. 搜索品项
  ```javascript
  const result = await projectApi.searchProjects('关键词', {
      currentPage: 1,
      pageSize: 20
  });
  ```
  
  ### 4. 获取品项详情
  ```javascript
  const detail = await projectApi.getProjectDetail('品项ID');
  ```
  
  ### 5. 创建品项
  ```javascript
  const data = {
      xmmc: '品项名称',
      pxjg: 100, // 价格
      description: '描述'
  };
  const result = await projectApi.createProject(data);
  ```
  
  ### 6. 更新品项
  ```javascript
  const data = {
      xmmc: '更新后的名称',
      pxjg: 150
  };
  const result = await projectApi.updateProject('品项ID', data);
  ```
  
  ### 7. 删除品项
  ```javascript
  const result = await projectApi.deleteProject('品项ID');
  ```
  
  ## 在Vue组件中使用
  
  ### 1. 导入API
  ```javascript
  import projectApi from '@/apis/modules/project.js'
  ```
  
  ### 2. 在方法中调用
  ```javascript
  methods: {
      async loadProjectOptions() {
          try {
              const options = await projectApi.getProjectOptions();
              this.projectOptions = options;
          } catch (error) {
              console.error('加载品项选项失败:', error);
          }
      }
  }
  ```
  
  ### 3. 在页面加载时调用
  ```javascript
  async onLoad() {
      await this.loadProjectOptions();
  }
  ```
  
  ## 返回数据格式
  
  ### 品项选项格式
  ```javascript
  [
      {
          value: '1',           // 品项ID
          label: '品项名称',     // 显示名称
          px: '1',             // 品项ID(兼容字段)
          pxmc: '品项名称',     // 品项名称(兼容字段)
          pxjg: 100,           // 品项价格
          qt2: '',             // 其他字段
          description: '',     // 描述
          status: 1            // 状态
      }
  ]
  ```
  
  ## 错误处理
  
  所有API调用都应该包含错误处理:
  
  ```javascript
  try {
      const result = await projectApi.getProjectOptions();
      // 处理成功结果
  } catch (error) {
      console.error('API调用失败:', error);
      // 处理错误情况
  }
  ```
  
  ## 注意事项
  
  1. 所有API调用都是异步的,需要使用 `await` 或 `.then()`
  2. 当API调用失败时,`getProjectOptions` 会返回默认数据
  3. 分页参数 `currentPage` 从1开始
  4. 搜索参数 `xmmc` 用于按品项名称搜索
  5. 建议在生产环境中添加适当的错误提示给用户