@ebiz/designer-components 0.0.58 → 0.0.59
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -29
- package/dist/designer-components.css +1 -1
- package/dist/index.mjs +4822 -4822
- package/package.json +1 -1
- package/src/App.vue +26 -26
- package/src/apiService/SIMPLE_DATA_SERVICE.md +284 -284
- package/src/apiService/mockDataService.js +115 -115
- package/src/apiService/simpleDataService.js +297 -297
- package/src/assets/base.css +86 -86
- package/src/assets/logo.svg +1 -1
- package/src/components/Button.vue +149 -149
- package/src/components/DataContainer.vue +40 -40
- package/src/components/EbizApproval.vue +332 -338
- package/src/components/EbizAutoForm.vue +596 -596
- package/src/components/EbizAvatar.vue +115 -115
- package/src/components/EbizCheckbox.vue +93 -93
- package/src/components/EbizCheckboxGroup.vue +69 -69
- package/src/components/EbizDepartmentSelector.vue +144 -144
- package/src/components/EbizDescriptions.vue +340 -340
- package/src/components/EbizDescriptionsItem.vue +47 -47
- package/src/components/EbizDetailBlock.vue +81 -81
- package/src/components/EbizDialog.vue +260 -260
- package/src/components/EbizDiv.vue +32 -32
- package/src/components/EbizDivider.vue +96 -96
- package/src/components/EbizEmployeeInfo.vue +138 -138
- package/src/components/EbizEmployeeSelector.vue +1093 -1086
- package/src/components/EbizFileUpload.vue +238 -238
- package/src/components/EbizMap.vue +541 -541
- package/src/components/EbizOkrTree.vue +99 -99
- package/src/components/EbizPageHeader.vue +95 -95
- package/src/components/EbizPagination.vue +162 -162
- package/src/components/EbizPopconfirm.vue +47 -47
- package/src/components/EbizRadio.vue +86 -86
- package/src/components/EbizRadioGroup.vue +83 -83
- package/src/components/EbizRemoteSelect.vue +232 -232
- package/src/components/EbizRouteBreadcrumb.vue +46 -46
- package/src/components/EbizSelect.vue +85 -85
- package/src/components/EbizSpace.vue +100 -100
- package/src/components/EbizStatistic.vue +149 -149
- package/src/components/EbizStatsCard.vue +113 -113
- package/src/components/EbizSwiper.vue +113 -113
- package/src/components/EbizSwiperItem.vue +13 -13
- package/src/components/EbizSwitch.vue +85 -85
- package/src/components/EbizTabHeader.vue +132 -132
- package/src/components/EbizTabPanel.vue +22 -22
- package/src/components/EbizTable.vue +469 -469
- package/src/components/EbizTableColumn.vue +116 -116
- package/src/components/EbizTableSort.vue +179 -179
- package/src/components/EbizTabs.vue +142 -142
- package/src/components/EbizTdesignButtonDialog.vue +332 -332
- package/src/components/EbizTdesignLoading.vue +107 -107
- package/src/components/EbizTimePicker.vue +143 -143
- package/src/components/EbizTitle.vue +91 -91
- package/src/components/EbizTree.vue +152 -152
- package/src/components/EbizTreeMergeTable.vue +1414 -1414
- package/src/components/EbizTreeSelector.vue +418 -418
- package/src/components/EbizVxeTable.vue +290 -290
- package/src/components/Form.vue +28 -28
- package/src/components/Home.vue +7 -7
- package/src/components/MyComponent.vue +39 -39
- package/src/components/Table.vue +45 -45
- package/src/components/TdesignAlert.vue +115 -115
- package/src/components/TdesignButton.vue +135 -135
- package/src/components/TdesignCalendar/index.vue +145 -145
- package/src/components/TdesignCard.vue +195 -195
- package/src/components/TdesignCol.vue +101 -101
- package/src/components/TdesignCollapse.vue +142 -142
- package/src/components/TdesignCollapsePanel.vue +79 -79
- package/src/components/TdesignDatePicker.vue +124 -124
- package/src/components/TdesignDescriptions.vue +74 -74
- package/src/components/TdesignDescriptionsItem.vue +50 -50
- package/src/components/TdesignDialog.vue +225 -225
- package/src/components/TdesignForm.vue +138 -138
- package/src/components/TdesignFormItem.vue +105 -105
- package/src/components/TdesignGrid.vue +55 -55
- package/src/components/TdesignIcon.vue +67 -67
- package/src/components/TdesignImage.vue +162 -162
- package/src/components/TdesignImageViewer.vue +200 -200
- package/src/components/TdesignInput.vue +242 -242
- package/src/components/TdesignSelect.vue +444 -444
- package/src/components/TdesignTag.vue +117 -117
- package/src/components/TdesignTextarea.vue +142 -142
- package/src/components/TdesignTimeline.vue +58 -58
- package/src/components/TdesignTimelineItem.vue +71 -71
- package/src/components/TdesignUpload.vue +388 -388
- package/src/components/TdesignWatermark.vue +107 -107
- package/src/components/ebiz-form/components/cascader.vue +61 -61
- package/src/components/ebiz-form/components/checkbox.vue +37 -37
- package/src/components/ebiz-form/components/city.vue +137 -137
- package/src/components/ebiz-form/components/date-panel.vue +52 -52
- package/src/components/ebiz-form/components/date-range-panel.vue +52 -52
- package/src/components/ebiz-form/components/date-range.vue +56 -56
- package/src/components/ebiz-form/components/date.vue +52 -52
- package/src/components/ebiz-form/components/editor-multi-language.vue +47 -47
- package/src/components/ebiz-form/components/editor.vue +78 -78
- package/src/components/ebiz-form/components/file-multi-language.vue +52 -52
- package/src/components/ebiz-form/components/file.vue +149 -149
- package/src/components/ebiz-form/components/images-multi-language.vue +52 -52
- package/src/components/ebiz-form/components/images.vue +129 -129
- package/src/components/ebiz-form/components/img-multi-language.vue +51 -51
- package/src/components/ebiz-form/components/img.vue +129 -129
- package/src/components/ebiz-form/components/number.vue +50 -50
- package/src/components/ebiz-form/components/radio.vue +28 -28
- package/src/components/ebiz-form/components/select.vue +119 -119
- package/src/components/ebiz-form/components/switch.vue +23 -23
- package/src/components/ebiz-form/components/text-multi-language.vue +47 -47
- package/src/components/ebiz-form/components/text.vue +52 -52
- package/src/components/ebiz-form/components/textarea-multi-language.vue +48 -48
- package/src/components/ebiz-form/components/textarea.vue +29 -29
- package/src/components/ebiz-form/components/video-multi-language.vue +51 -51
- package/src/components/ebiz-form/components/video.vue +97 -97
- package/src/components/ebiz-form/index.vue +157 -157
- package/src/components/examples/PopconfirmExample.vue +149 -149
- package/src/components/icons/IconCommunity.vue +7 -7
- package/src/components/icons/IconDocumentation.vue +7 -7
- package/src/components/icons/IconEcosystem.vue +7 -7
- package/src/components/icons/IconSupport.vue +7 -7
- package/src/components/icons/IconTooling.vue +19 -19
- package/src/components/senior/EbizSData/index.vue +260 -260
- package/src/components/senior/EbizSDialog/index.vue +713 -713
- package/src/components/senior/EbizSForm/README.md +157 -157
- package/src/components/senior/EbizSForm/index.vue +668 -668
- package/src/components/senior/EbizSForm/item.vue +522 -522
- package/src/components/senior/EbizSForm/mItems/DateTimePicker.vue +51 -51
- package/src/components/senior/EbizSForm/mItems/Picker.vue +63 -63
- package/src/index.js +218 -218
- package/src/main.js +55 -55
- package/src/router/index.js +374 -374
- package/src/utils/formatCode.js +24 -24
- package/src/utils/generateImportStatement.js +52 -52
- package/src/utils/hasJsx.js +25 -25
- package/src/utils/index.js +166 -166
- package/src/utils/mergeOptions.js +29 -29
- package/src/utils/parseRequiredBlocks.js +18 -18
- package/src/utils/upload.ts +126 -126
- package/src/utils/vue-sfc-validator.js +155 -155
- package/src/views/Button.vue +23 -23
- package/src/views/CheckboxDemo.vue +104 -104
- package/src/views/DataContainer.vue +19 -19
- package/src/views/DialogDemo.vue +125 -125
- package/src/views/EbizApprovalDemo.vue +76 -76
- package/src/views/EbizAutoFormDemo.vue +129 -129
- package/src/views/EbizAvatar.vue +223 -223
- package/src/views/EbizDepartmentSelectorDemo.vue +169 -169
- package/src/views/EbizDetailBlockDemo.vue +30 -30
- package/src/views/EbizEmployeeInfo.vue +249 -249
- package/src/views/EbizEmployeeSelector.vue +83 -83
- package/src/views/EbizMap.vue +201 -201
- package/src/views/EbizRadioDemo.vue +151 -151
- package/src/views/EbizSDataDemo.vue +136 -136
- package/src/views/EbizSDialogDemo.vue +301 -301
- package/src/views/EbizSForm/index.vue +359 -359
- package/src/views/EbizSFormDemo.vue +420 -420
- package/src/views/EbizSpace.vue +185 -185
- package/src/views/EbizSwiper.vue +157 -157
- package/src/views/EbizTdesignButtonDialogExample.vue +437 -437
- package/src/views/Form.vue +19 -19
- package/src/views/GridDemo.vue +238 -238
- package/src/views/Home.vue +146 -146
- package/src/views/Mindmap.vue +17 -17
- package/src/views/MyComponent.vue +19 -19
- package/src/views/OkrTree.vue +19 -19
- package/src/views/PageHeaderDemo.vue +104 -104
- package/src/views/PaginationDemo.vue +96 -96
- package/src/views/PermissionBoxDemo.vue +85 -85
- package/src/views/PopconfirmDemo.vue +80 -80
- package/src/views/RemoteSelect.vue +350 -350
- package/src/views/StatisticDemo.vue +190 -190
- package/src/views/SwitchDemo.vue +79 -79
- package/src/views/Table.vue +19 -19
- package/src/views/TableDemo.vue +334 -334
- package/src/views/TableSortDemo.vue +143 -143
- package/src/views/TableView.vue +68 -68
- package/src/views/TabsDemo.vue +282 -282
- package/src/views/TagDemo.vue +101 -101
- package/src/views/TdesignAlert.vue +98 -98
- package/src/views/TdesignButton.vue +190 -190
- package/src/views/TdesignCalendar.vue +94 -94
- package/src/views/TdesignCard.vue +296 -296
- package/src/views/TdesignCollapse.vue +293 -293
- package/src/views/TdesignDatePicker.vue +187 -187
- package/src/views/TdesignDescriptions.vue +101 -101
- package/src/views/TdesignForm.vue +248 -248
- package/src/views/TdesignIcon.vue +203 -203
- package/src/views/TdesignImage.vue +215 -215
- package/src/views/TdesignImageViewer.vue +198 -198
- package/src/views/TdesignInput.vue +252 -252
- package/src/views/TdesignSelect.vue +473 -473
- package/src/views/TdesignSwiper.vue +157 -157
- package/src/views/TextareaDemo.vue +93 -93
- package/src/views/TimePickerDemo.vue +146 -146
- package/src/views/TimelineDemo.vue +160 -160
- package/src/views/Title.vue +19 -19
- package/src/views/TreeDemo.vue +254 -254
- package/src/views/TreeMergeTableDemo.vue +239 -239
- package/src/views/TreeSelectorDemo.vue +245 -245
- package/src/views/UploadDemo.vue +121 -121
- package/src/views/VxeTableDemo.vue +279 -279
- package/src/views/WatermarkDemo.vue +85 -85
package/package.json
CHANGED
package/src/App.vue
CHANGED
@@ -1,26 +1,26 @@
|
|
1
|
-
<script>
|
2
|
-
export default {
|
3
|
-
name: 'App'
|
4
|
-
}
|
5
|
-
</script>
|
6
|
-
|
7
|
-
<template>
|
8
|
-
<div id="app">
|
9
|
-
<router-view></router-view>
|
10
|
-
</div>
|
11
|
-
</template>
|
12
|
-
|
13
|
-
<style>
|
14
|
-
#app {
|
15
|
-
font-family: Arial, sans-serif;
|
16
|
-
-webkit-font-smoothing: antialiased;
|
17
|
-
-moz-osx-font-smoothing: grayscale;
|
18
|
-
color: #2c3e50;
|
19
|
-
}
|
20
|
-
|
21
|
-
* {
|
22
|
-
margin: 0;
|
23
|
-
padding: 0;
|
24
|
-
box-sizing: border-box;
|
25
|
-
}
|
26
|
-
</style>
|
1
|
+
<script>
|
2
|
+
export default {
|
3
|
+
name: 'App'
|
4
|
+
}
|
5
|
+
</script>
|
6
|
+
|
7
|
+
<template>
|
8
|
+
<div id="app">
|
9
|
+
<router-view></router-view>
|
10
|
+
</div>
|
11
|
+
</template>
|
12
|
+
|
13
|
+
<style>
|
14
|
+
#app {
|
15
|
+
font-family: Arial, sans-serif;
|
16
|
+
-webkit-font-smoothing: antialiased;
|
17
|
+
-moz-osx-font-smoothing: grayscale;
|
18
|
+
color: #2c3e50;
|
19
|
+
}
|
20
|
+
|
21
|
+
* {
|
22
|
+
margin: 0;
|
23
|
+
padding: 0;
|
24
|
+
box-sizing: border-box;
|
25
|
+
}
|
26
|
+
</style>
|
@@ -1,285 +1,285 @@
|
|
1
|
-
# 简洁数据服务使用指南
|
2
|
-
|
3
|
-
这个简洁数据服务提供了基本的数据操作方法,包括列表查询、详情查询、数据写入、数据修改、数据删除,每个方法都包含基础的API配置,包括apiId参数。**所有接口均使用POST方法提交**,包括查询接口。
|
4
|
-
|
5
|
-
## 配置
|
6
|
-
|
7
|
-
数据服务通过环境变量配置域名,支持以下环境变量:
|
8
|
-
|
9
|
-
- `VUE_APP_API_BASE_URL`: 在Vue CLI项目中使用
|
10
|
-
- `VITE_API_BASE_URL`: 在Vite项目中使用
|
11
|
-
|
12
|
-
您可以在项目的`.env`文件中配置这些环境变量:
|
13
|
-
|
14
|
-
```
|
15
|
-
# .env.development
|
16
|
-
VITE_API_BASE_URL=http://localhost:3000/api
|
17
|
-
|
18
|
-
# .env.production
|
19
|
-
VITE_API_BASE_URL=https://api.example.com
|
20
|
-
```
|
21
|
-
|
22
|
-
## 基本用法
|
23
|
-
|
24
|
-
### 导入组件
|
25
|
-
|
26
|
-
```javascript
|
27
|
-
// 导入数据服务
|
28
|
-
import { dataService } from '@ebiz/lowcode-components';
|
29
|
-
```
|
30
|
-
|
31
|
-
### 查询列表数据 (POST方法)
|
32
|
-
|
33
|
-
```javascript
|
34
|
-
// 查询用户列表
|
35
|
-
dataService.queryList('/users/list', { page: 1, pageSize: 10 }, { apiId: 'getUserList' })
|
36
|
-
.then(data => {
|
37
|
-
console.log('用户列表:', data);
|
38
|
-
})
|
39
|
-
.catch(error => {
|
40
|
-
console.error('获取用户列表失败:', error);
|
41
|
-
});
|
42
|
-
|
43
|
-
// 使用自定义API配置
|
44
|
-
dataService.queryList('/users/list', { status: 'active' }, {
|
45
|
-
apiId: 'getActiveUsers',
|
46
|
-
headers: {
|
47
|
-
'X-Custom-Header': 'custom-value'
|
48
|
-
},
|
49
|
-
timeout: 10000
|
50
|
-
})
|
51
|
-
.then(data => {
|
52
|
-
console.log('活跃用户列表:', data);
|
53
|
-
})
|
54
|
-
.catch(error => {
|
55
|
-
console.error('获取活跃用户列表失败:', error);
|
56
|
-
});
|
57
|
-
```
|
58
|
-
|
59
|
-
### 查询详情数据 (POST方法)
|
60
|
-
|
61
|
-
```javascript
|
62
|
-
// 查询用户详情
|
63
|
-
dataService.queryDetail('/users/detail', '123', {}, { apiId: 'getUserDetail' })
|
64
|
-
.then(data => {
|
65
|
-
console.log('用户详情:', data);
|
66
|
-
})
|
67
|
-
.catch(error => {
|
68
|
-
console.error('获取用户详情失败:', error);
|
69
|
-
});
|
70
|
-
|
71
|
-
// 查询用户详情,包含关联数据
|
72
|
-
dataService.queryDetail('/users/detail', '123', { include: 'orders,profile' }, { apiId: 'getUserDetailWithRelations' })
|
73
|
-
.then(data => {
|
74
|
-
console.log('用户详情(包含关联数据):', data);
|
75
|
-
})
|
76
|
-
.catch(error => {
|
77
|
-
console.error('获取用户详情失败:', error);
|
78
|
-
});
|
79
|
-
```
|
80
|
-
|
81
|
-
### 新增数据 (POST方法)
|
82
|
-
|
83
|
-
```javascript
|
84
|
-
// 创建用户
|
85
|
-
dataService.create('/users/create', {
|
86
|
-
name: '张三',
|
87
|
-
email: 'zhangsan@example.com',
|
88
|
-
role: 'user'
|
89
|
-
}, { apiId: 'createUser' })
|
90
|
-
.then(data => {
|
91
|
-
console.log('创建用户成功:', data);
|
92
|
-
})
|
93
|
-
.catch(error => {
|
94
|
-
console.error('创建用户失败:', error);
|
95
|
-
});
|
96
|
-
|
97
|
-
// 使用自定义API配置创建用户
|
98
|
-
dataService.create('/users/create', {
|
99
|
-
name: '李四',
|
100
|
-
email: 'lisi@example.com',
|
101
|
-
role: 'admin'
|
102
|
-
}, {
|
103
|
-
apiId: 'createAdminUser',
|
104
|
-
headers: {
|
105
|
-
'X-Admin-Create': 'true'
|
106
|
-
}
|
107
|
-
})
|
108
|
-
.then(data => {
|
109
|
-
console.log('创建管理员用户成功:', data);
|
110
|
-
})
|
111
|
-
.catch(error => {
|
112
|
-
console.error('创建管理员用户失败:', error);
|
113
|
-
});
|
114
|
-
```
|
115
|
-
|
116
|
-
### 更新数据 (POST方法)
|
117
|
-
|
118
|
-
```javascript
|
119
|
-
// 更新用户
|
120
|
-
dataService.update('/users/update', '123', {
|
121
|
-
name: '张三(已更新)',
|
122
|
-
email: 'zhangsan_updated@example.com'
|
123
|
-
}, { apiId: 'updateUser' })
|
124
|
-
.then(data => {
|
125
|
-
console.log('更新用户成功:', data);
|
126
|
-
})
|
127
|
-
.catch(error => {
|
128
|
-
console.error('更新用户失败:', error);
|
129
|
-
});
|
130
|
-
|
131
|
-
// 使用自定义API配置更新用户
|
132
|
-
dataService.update('/users/update', '123', {
|
133
|
-
status: 'inactive'
|
134
|
-
}, {
|
135
|
-
apiId: 'updateUserStatus',
|
136
|
-
headers: {
|
137
|
-
'X-Status-Update': 'true'
|
138
|
-
}
|
139
|
-
})
|
140
|
-
.then(data => {
|
141
|
-
console.log('更新用户状态成功:', data);
|
142
|
-
})
|
143
|
-
.catch(error => {
|
144
|
-
console.error('更新用户状态失败:', error);
|
145
|
-
});
|
146
|
-
```
|
147
|
-
|
148
|
-
### 删除数据 (POST方法)
|
149
|
-
|
150
|
-
```javascript
|
151
|
-
// 删除用户
|
152
|
-
dataService.delete('/users/delete', '123', {}, { apiId: 'deleteUser' })
|
153
|
-
.then(data => {
|
154
|
-
console.log('删除用户成功:', data);
|
155
|
-
})
|
156
|
-
.catch(error => {
|
157
|
-
console.error('删除用户失败:', error);
|
158
|
-
});
|
159
|
-
|
160
|
-
// 软删除用户
|
161
|
-
dataService.delete('/users/delete', '123', { soft: true }, { apiId: 'softDeleteUser' })
|
162
|
-
.then(data => {
|
163
|
-
console.log('软删除用户成功:', data);
|
164
|
-
})
|
165
|
-
.catch(error => {
|
166
|
-
console.error('软删除用户失败:', error);
|
167
|
-
});
|
168
|
-
```
|
169
|
-
|
170
|
-
### 批量操作 (POST方法)
|
171
|
-
|
172
|
-
```javascript
|
173
|
-
// 批量删除用户
|
174
|
-
dataService.batch('/users/batch', 'delete', ['123', '456', '789'], {}, { apiId: 'batchDeleteUsers' })
|
175
|
-
.then(data => {
|
176
|
-
console.log('批量删除用户成功:', data);
|
177
|
-
})
|
178
|
-
.catch(error => {
|
179
|
-
console.error('批量删除用户失败:', error);
|
180
|
-
});
|
181
|
-
|
182
|
-
// 批量更新用户状态
|
183
|
-
dataService.batch('/users/batch', 'update', ['123', '456'], {
|
184
|
-
status: 'active'
|
185
|
-
}, { apiId: 'batchUpdateUserStatus' })
|
186
|
-
.then(data => {
|
187
|
-
console.log('批量更新用户状态成功:', data);
|
188
|
-
})
|
189
|
-
.catch(error => {
|
190
|
-
console.error('批量更新用户状态失败:', error);
|
191
|
-
});
|
192
|
-
```
|
193
|
-
|
194
|
-
## 请求数据格式
|
195
|
-
|
196
|
-
所有方法都使用POST方法提交数据,请求体格式如下:
|
197
|
-
|
198
|
-
### 查询列表
|
199
|
-
```json
|
200
|
-
{
|
201
|
-
"page": 1,
|
202
|
-
"pageSize": 10,
|
203
|
-
"其他查询参数": "值"
|
204
|
-
}
|
205
|
-
```
|
206
|
-
|
207
|
-
### 查询详情
|
208
|
-
```json
|
209
|
-
{
|
210
|
-
"id": "123",
|
211
|
-
"include": "orders,profile",
|
212
|
-
"其他查询参数": "值"
|
213
|
-
}
|
214
|
-
```
|
215
|
-
|
216
|
-
### 新增数据
|
217
|
-
```json
|
218
|
-
{
|
219
|
-
"name": "张三",
|
220
|
-
"email": "zhangsan@example.com",
|
221
|
-
"role": "user",
|
222
|
-
"其他字段": "值"
|
223
|
-
}
|
224
|
-
```
|
225
|
-
|
226
|
-
### 更新数据
|
227
|
-
```json
|
228
|
-
{
|
229
|
-
"id": "123",
|
230
|
-
"name": "张三(已更新)",
|
231
|
-
"email": "zhangsan_updated@example.com",
|
232
|
-
"其他字段": "值"
|
233
|
-
}
|
234
|
-
```
|
235
|
-
|
236
|
-
### 删除数据
|
237
|
-
```json
|
238
|
-
{
|
239
|
-
"id": "123",
|
240
|
-
"soft": true,
|
241
|
-
"其他参数": "值"
|
242
|
-
}
|
243
|
-
```
|
244
|
-
|
245
|
-
### 批量操作
|
246
|
-
```json
|
247
|
-
{
|
248
|
-
"action": "delete",
|
249
|
-
"ids": ["123", "456", "789"],
|
250
|
-
"其他参数": "值"
|
251
|
-
}
|
252
|
-
```
|
253
|
-
|
254
|
-
## API配置选项
|
255
|
-
|
256
|
-
每个方法都支持自定义API配置,常用的配置选项包括:
|
257
|
-
|
258
|
-
| 配置项 | 类型 | 说明 |
|
259
|
-
|-------|------|------|
|
260
|
-
| apiId | String | API标识,用于标识请求的API |
|
261
|
-
| headers | Object | 自定义请求头 |
|
262
|
-
| timeout | Number | 请求超时时间(毫秒) |
|
263
|
-
| withCredentials | Boolean | 是否携带凭证(cookies) |
|
264
|
-
| responseType | String | 响应类型,如'json'、'blob'、'text'等 |
|
265
|
-
|
266
|
-
示例:
|
267
|
-
|
268
|
-
```javascript
|
269
|
-
// 使用完整的API配置
|
270
|
-
dataService.queryList('/users/list', { page: 1 }, {
|
271
|
-
apiId: 'getUserListWithConfig',
|
272
|
-
headers: {
|
273
|
-
'X-Custom-Header': 'custom-value'
|
274
|
-
},
|
275
|
-
timeout: 15000,
|
276
|
-
withCredentials: true,
|
277
|
-
responseType: 'json'
|
278
|
-
})
|
279
|
-
.then(data => {
|
280
|
-
console.log('用户列表:', data);
|
281
|
-
})
|
282
|
-
.catch(error => {
|
283
|
-
console.error('获取用户列表失败:', error);
|
284
|
-
});
|
1
|
+
# 简洁数据服务使用指南
|
2
|
+
|
3
|
+
这个简洁数据服务提供了基本的数据操作方法,包括列表查询、详情查询、数据写入、数据修改、数据删除,每个方法都包含基础的API配置,包括apiId参数。**所有接口均使用POST方法提交**,包括查询接口。
|
4
|
+
|
5
|
+
## 配置
|
6
|
+
|
7
|
+
数据服务通过环境变量配置域名,支持以下环境变量:
|
8
|
+
|
9
|
+
- `VUE_APP_API_BASE_URL`: 在Vue CLI项目中使用
|
10
|
+
- `VITE_API_BASE_URL`: 在Vite项目中使用
|
11
|
+
|
12
|
+
您可以在项目的`.env`文件中配置这些环境变量:
|
13
|
+
|
14
|
+
```
|
15
|
+
# .env.development
|
16
|
+
VITE_API_BASE_URL=http://localhost:3000/api
|
17
|
+
|
18
|
+
# .env.production
|
19
|
+
VITE_API_BASE_URL=https://api.example.com
|
20
|
+
```
|
21
|
+
|
22
|
+
## 基本用法
|
23
|
+
|
24
|
+
### 导入组件
|
25
|
+
|
26
|
+
```javascript
|
27
|
+
// 导入数据服务
|
28
|
+
import { dataService } from '@ebiz/lowcode-components';
|
29
|
+
```
|
30
|
+
|
31
|
+
### 查询列表数据 (POST方法)
|
32
|
+
|
33
|
+
```javascript
|
34
|
+
// 查询用户列表
|
35
|
+
dataService.queryList('/users/list', { page: 1, pageSize: 10 }, { apiId: 'getUserList' })
|
36
|
+
.then(data => {
|
37
|
+
console.log('用户列表:', data);
|
38
|
+
})
|
39
|
+
.catch(error => {
|
40
|
+
console.error('获取用户列表失败:', error);
|
41
|
+
});
|
42
|
+
|
43
|
+
// 使用自定义API配置
|
44
|
+
dataService.queryList('/users/list', { status: 'active' }, {
|
45
|
+
apiId: 'getActiveUsers',
|
46
|
+
headers: {
|
47
|
+
'X-Custom-Header': 'custom-value'
|
48
|
+
},
|
49
|
+
timeout: 10000
|
50
|
+
})
|
51
|
+
.then(data => {
|
52
|
+
console.log('活跃用户列表:', data);
|
53
|
+
})
|
54
|
+
.catch(error => {
|
55
|
+
console.error('获取活跃用户列表失败:', error);
|
56
|
+
});
|
57
|
+
```
|
58
|
+
|
59
|
+
### 查询详情数据 (POST方法)
|
60
|
+
|
61
|
+
```javascript
|
62
|
+
// 查询用户详情
|
63
|
+
dataService.queryDetail('/users/detail', '123', {}, { apiId: 'getUserDetail' })
|
64
|
+
.then(data => {
|
65
|
+
console.log('用户详情:', data);
|
66
|
+
})
|
67
|
+
.catch(error => {
|
68
|
+
console.error('获取用户详情失败:', error);
|
69
|
+
});
|
70
|
+
|
71
|
+
// 查询用户详情,包含关联数据
|
72
|
+
dataService.queryDetail('/users/detail', '123', { include: 'orders,profile' }, { apiId: 'getUserDetailWithRelations' })
|
73
|
+
.then(data => {
|
74
|
+
console.log('用户详情(包含关联数据):', data);
|
75
|
+
})
|
76
|
+
.catch(error => {
|
77
|
+
console.error('获取用户详情失败:', error);
|
78
|
+
});
|
79
|
+
```
|
80
|
+
|
81
|
+
### 新增数据 (POST方法)
|
82
|
+
|
83
|
+
```javascript
|
84
|
+
// 创建用户
|
85
|
+
dataService.create('/users/create', {
|
86
|
+
name: '张三',
|
87
|
+
email: 'zhangsan@example.com',
|
88
|
+
role: 'user'
|
89
|
+
}, { apiId: 'createUser' })
|
90
|
+
.then(data => {
|
91
|
+
console.log('创建用户成功:', data);
|
92
|
+
})
|
93
|
+
.catch(error => {
|
94
|
+
console.error('创建用户失败:', error);
|
95
|
+
});
|
96
|
+
|
97
|
+
// 使用自定义API配置创建用户
|
98
|
+
dataService.create('/users/create', {
|
99
|
+
name: '李四',
|
100
|
+
email: 'lisi@example.com',
|
101
|
+
role: 'admin'
|
102
|
+
}, {
|
103
|
+
apiId: 'createAdminUser',
|
104
|
+
headers: {
|
105
|
+
'X-Admin-Create': 'true'
|
106
|
+
}
|
107
|
+
})
|
108
|
+
.then(data => {
|
109
|
+
console.log('创建管理员用户成功:', data);
|
110
|
+
})
|
111
|
+
.catch(error => {
|
112
|
+
console.error('创建管理员用户失败:', error);
|
113
|
+
});
|
114
|
+
```
|
115
|
+
|
116
|
+
### 更新数据 (POST方法)
|
117
|
+
|
118
|
+
```javascript
|
119
|
+
// 更新用户
|
120
|
+
dataService.update('/users/update', '123', {
|
121
|
+
name: '张三(已更新)',
|
122
|
+
email: 'zhangsan_updated@example.com'
|
123
|
+
}, { apiId: 'updateUser' })
|
124
|
+
.then(data => {
|
125
|
+
console.log('更新用户成功:', data);
|
126
|
+
})
|
127
|
+
.catch(error => {
|
128
|
+
console.error('更新用户失败:', error);
|
129
|
+
});
|
130
|
+
|
131
|
+
// 使用自定义API配置更新用户
|
132
|
+
dataService.update('/users/update', '123', {
|
133
|
+
status: 'inactive'
|
134
|
+
}, {
|
135
|
+
apiId: 'updateUserStatus',
|
136
|
+
headers: {
|
137
|
+
'X-Status-Update': 'true'
|
138
|
+
}
|
139
|
+
})
|
140
|
+
.then(data => {
|
141
|
+
console.log('更新用户状态成功:', data);
|
142
|
+
})
|
143
|
+
.catch(error => {
|
144
|
+
console.error('更新用户状态失败:', error);
|
145
|
+
});
|
146
|
+
```
|
147
|
+
|
148
|
+
### 删除数据 (POST方法)
|
149
|
+
|
150
|
+
```javascript
|
151
|
+
// 删除用户
|
152
|
+
dataService.delete('/users/delete', '123', {}, { apiId: 'deleteUser' })
|
153
|
+
.then(data => {
|
154
|
+
console.log('删除用户成功:', data);
|
155
|
+
})
|
156
|
+
.catch(error => {
|
157
|
+
console.error('删除用户失败:', error);
|
158
|
+
});
|
159
|
+
|
160
|
+
// 软删除用户
|
161
|
+
dataService.delete('/users/delete', '123', { soft: true }, { apiId: 'softDeleteUser' })
|
162
|
+
.then(data => {
|
163
|
+
console.log('软删除用户成功:', data);
|
164
|
+
})
|
165
|
+
.catch(error => {
|
166
|
+
console.error('软删除用户失败:', error);
|
167
|
+
});
|
168
|
+
```
|
169
|
+
|
170
|
+
### 批量操作 (POST方法)
|
171
|
+
|
172
|
+
```javascript
|
173
|
+
// 批量删除用户
|
174
|
+
dataService.batch('/users/batch', 'delete', ['123', '456', '789'], {}, { apiId: 'batchDeleteUsers' })
|
175
|
+
.then(data => {
|
176
|
+
console.log('批量删除用户成功:', data);
|
177
|
+
})
|
178
|
+
.catch(error => {
|
179
|
+
console.error('批量删除用户失败:', error);
|
180
|
+
});
|
181
|
+
|
182
|
+
// 批量更新用户状态
|
183
|
+
dataService.batch('/users/batch', 'update', ['123', '456'], {
|
184
|
+
status: 'active'
|
185
|
+
}, { apiId: 'batchUpdateUserStatus' })
|
186
|
+
.then(data => {
|
187
|
+
console.log('批量更新用户状态成功:', data);
|
188
|
+
})
|
189
|
+
.catch(error => {
|
190
|
+
console.error('批量更新用户状态失败:', error);
|
191
|
+
});
|
192
|
+
```
|
193
|
+
|
194
|
+
## 请求数据格式
|
195
|
+
|
196
|
+
所有方法都使用POST方法提交数据,请求体格式如下:
|
197
|
+
|
198
|
+
### 查询列表
|
199
|
+
```json
|
200
|
+
{
|
201
|
+
"page": 1,
|
202
|
+
"pageSize": 10,
|
203
|
+
"其他查询参数": "值"
|
204
|
+
}
|
205
|
+
```
|
206
|
+
|
207
|
+
### 查询详情
|
208
|
+
```json
|
209
|
+
{
|
210
|
+
"id": "123",
|
211
|
+
"include": "orders,profile",
|
212
|
+
"其他查询参数": "值"
|
213
|
+
}
|
214
|
+
```
|
215
|
+
|
216
|
+
### 新增数据
|
217
|
+
```json
|
218
|
+
{
|
219
|
+
"name": "张三",
|
220
|
+
"email": "zhangsan@example.com",
|
221
|
+
"role": "user",
|
222
|
+
"其他字段": "值"
|
223
|
+
}
|
224
|
+
```
|
225
|
+
|
226
|
+
### 更新数据
|
227
|
+
```json
|
228
|
+
{
|
229
|
+
"id": "123",
|
230
|
+
"name": "张三(已更新)",
|
231
|
+
"email": "zhangsan_updated@example.com",
|
232
|
+
"其他字段": "值"
|
233
|
+
}
|
234
|
+
```
|
235
|
+
|
236
|
+
### 删除数据
|
237
|
+
```json
|
238
|
+
{
|
239
|
+
"id": "123",
|
240
|
+
"soft": true,
|
241
|
+
"其他参数": "值"
|
242
|
+
}
|
243
|
+
```
|
244
|
+
|
245
|
+
### 批量操作
|
246
|
+
```json
|
247
|
+
{
|
248
|
+
"action": "delete",
|
249
|
+
"ids": ["123", "456", "789"],
|
250
|
+
"其他参数": "值"
|
251
|
+
}
|
252
|
+
```
|
253
|
+
|
254
|
+
## API配置选项
|
255
|
+
|
256
|
+
每个方法都支持自定义API配置,常用的配置选项包括:
|
257
|
+
|
258
|
+
| 配置项 | 类型 | 说明 |
|
259
|
+
|-------|------|------|
|
260
|
+
| apiId | String | API标识,用于标识请求的API |
|
261
|
+
| headers | Object | 自定义请求头 |
|
262
|
+
| timeout | Number | 请求超时时间(毫秒) |
|
263
|
+
| withCredentials | Boolean | 是否携带凭证(cookies) |
|
264
|
+
| responseType | String | 响应类型,如'json'、'blob'、'text'等 |
|
265
|
+
|
266
|
+
示例:
|
267
|
+
|
268
|
+
```javascript
|
269
|
+
// 使用完整的API配置
|
270
|
+
dataService.queryList('/users/list', { page: 1 }, {
|
271
|
+
apiId: 'getUserListWithConfig',
|
272
|
+
headers: {
|
273
|
+
'X-Custom-Header': 'custom-value'
|
274
|
+
},
|
275
|
+
timeout: 15000,
|
276
|
+
withCredentials: true,
|
277
|
+
responseType: 'json'
|
278
|
+
})
|
279
|
+
.then(data => {
|
280
|
+
console.log('用户列表:', data);
|
281
|
+
})
|
282
|
+
.catch(error => {
|
283
|
+
console.error('获取用户列表失败:', error);
|
284
|
+
});
|
285
285
|
```
|