@ebiz/designer-components 0.0.19-beta.9 → 0.0.20

package/src/apiService/SIMPLE_DATA_SERVICE.md

@@ -1,285 +1,285 @@
-# 简洁数据服务使用指南
-
-这个简洁数据服务提供了基本的数据操作方法，包括列表查询、详情查询、数据写入、数据修改、数据删除，每个方法都包含基础的API配置，包括apiId参数。**所有接口均使用POST方法提交**，包括查询接口。
-
-## 配置
-
-数据服务通过环境变量配置域名，支持以下环境变量：
-
-- `VUE_APP_API_BASE_URL`: 在Vue CLI项目中使用
-- `VITE_API_BASE_URL`: 在Vite项目中使用
-
-您可以在项目的`.env`文件中配置这些环境变量：
-
-```
-# .env.development
-VITE_API_BASE_URL=http://localhost:3000/api
-
-# .env.production
-VITE_API_BASE_URL=https://api.example.com
-```
-
-## 基本用法
-
-### 导入组件
-
-```javascript
-// 导入数据服务
-import { dataService } from '@ebiz/lowcode-components';
-```
-
-### 查询列表数据 (POST方法)
-
-```javascript
-// 查询用户列表
-dataService.queryList('/users/list', { page: 1, pageSize: 10 }, { apiId: 'getUserList' })
-  .then(data => {
-    console.log('用户列表:', data);
-  })
-  .catch(error => {
-    console.error('获取用户列表失败:', error);
-  });
-
-// 使用自定义API配置
-dataService.queryList('/users/list', { status: 'active' }, {
-  apiId: 'getActiveUsers',
-  headers: {
-    'X-Custom-Header': 'custom-value'
-  },
-  timeout: 10000
-})
-  .then(data => {
-    console.log('活跃用户列表:', data);
-  })
-  .catch(error => {
-    console.error('获取活跃用户列表失败:', error);
-  });
-```
-
-### 查询详情数据 (POST方法)
-
-```javascript
-// 查询用户详情
-dataService.queryDetail('/users/detail', '123', {}, { apiId: 'getUserDetail' })
-  .then(data => {
-    console.log('用户详情:', data);
-  })
-  .catch(error => {
-    console.error('获取用户详情失败:', error);
-  });
-
-// 查询用户详情，包含关联数据
-dataService.queryDetail('/users/detail', '123', { include: 'orders,profile' }, { apiId: 'getUserDetailWithRelations' })
-  .then(data => {
-    console.log('用户详情(包含关联数据):', data);
-  })
-  .catch(error => {
-    console.error('获取用户详情失败:', error);
-  });
-```
-
-### 新增数据 (POST方法)
-
-```javascript
-// 创建用户
-dataService.create('/users/create', {
-  name: '张三',
-  email: 'zhangsan@example.com',
-  role: 'user'
-}, { apiId: 'createUser' })
-  .then(data => {
-    console.log('创建用户成功:', data);
-  })
-  .catch(error => {
-    console.error('创建用户失败:', error);
-  });
-
-// 使用自定义API配置创建用户
-dataService.create('/users/create', {
-  name: '李四',
-  email: 'lisi@example.com',
-  role: 'admin'
-}, {
-  apiId: 'createAdminUser',
-  headers: {
-    'X-Admin-Create': 'true'
-  }
-})
-  .then(data => {
-    console.log('创建管理员用户成功:', data);
-  })
-  .catch(error => {
-    console.error('创建管理员用户失败:', error);
-  });
-```
-
-### 更新数据 (POST方法)
-
-```javascript
-// 更新用户
-dataService.update('/users/update', '123', {
-  name: '张三(已更新)',
-  email: 'zhangsan_updated@example.com'
-}, { apiId: 'updateUser' })
-  .then(data => {
-    console.log('更新用户成功:', data);
-  })
-  .catch(error => {
-    console.error('更新用户失败:', error);
-  });
-
-// 使用自定义API配置更新用户
-dataService.update('/users/update', '123', {
-  status: 'inactive'
-}, {
-  apiId: 'updateUserStatus',
-  headers: {
-    'X-Status-Update': 'true'
-  }
-})
-  .then(data => {
-    console.log('更新用户状态成功:', data);
-  })
-  .catch(error => {
-    console.error('更新用户状态失败:', error);
-  });
-```
-
-### 删除数据 (POST方法)
-
-```javascript
-// 删除用户
-dataService.delete('/users/delete', '123', {}, { apiId: 'deleteUser' })
-  .then(data => {
-    console.log('删除用户成功:', data);
-  })
-  .catch(error => {
-    console.error('删除用户失败:', error);
-  });
-
-// 软删除用户
-dataService.delete('/users/delete', '123', { soft: true }, { apiId: 'softDeleteUser' })
-  .then(data => {
-    console.log('软删除用户成功:', data);
-  })
-  .catch(error => {
-    console.error('软删除用户失败:', error);
-  });
-```
-
-### 批量操作 (POST方法)
-
-```javascript
-// 批量删除用户
-dataService.batch('/users/batch', 'delete', ['123', '456', '789'], {}, { apiId: 'batchDeleteUsers' })
-  .then(data => {
-    console.log('批量删除用户成功:', data);
-  })
-  .catch(error => {
-    console.error('批量删除用户失败:', error);
-  });
-
-// 批量更新用户状态
-dataService.batch('/users/batch', 'update', ['123', '456'], {
-  status: 'active'
-}, { apiId: 'batchUpdateUserStatus' })
-  .then(data => {
-    console.log('批量更新用户状态成功:', data);
-  })
-  .catch(error => {
-    console.error('批量更新用户状态失败:', error);
-  });
-```
-
-## 请求数据格式
-
-所有方法都使用POST方法提交数据，请求体格式如下：
-
-### 查询列表
-```json
-{
-  "page": 1,
-  "pageSize": 10,
-  "其他查询参数": "值"
-}
-```
-
-### 查询详情
-```json
-{
-  "id": "123",
-  "include": "orders,profile",
-  "其他查询参数": "值"
-}
-```
-
-### 新增数据
-```json
-{
-  "name": "张三",
-  "email": "zhangsan@example.com",
-  "role": "user",
-  "其他字段": "值"
-}
-```
-
-### 更新数据
-```json
-{
-  "id": "123",
-  "name": "张三(已更新)",
-  "email": "zhangsan_updated@example.com",
-  "其他字段": "值"
-}
-```
-
-### 删除数据
-```json
-{
-  "id": "123",
-  "soft": true,
-  "其他参数": "值"
-}
-```
-
-### 批量操作
-```json
-{
-  "action": "delete",
-  "ids": ["123", "456", "789"],
-  "其他参数": "值"
-}
-```
-
-## API配置选项
-
-每个方法都支持自定义API配置，常用的配置选项包括：
-
-| 配置项 | 类型 | 说明 |
-|-------|------|------|
-| apiId | String | API标识，用于标识请求的API |
-| headers | Object | 自定义请求头 |
-| timeout | Number | 请求超时时间(毫秒) |
-| withCredentials | Boolean | 是否携带凭证(cookies) |
-| responseType | String | 响应类型，如'json'、'blob'、'text'等 |
-
-示例：
-
-```javascript
-// 使用完整的API配置
-dataService.queryList('/users/list', { page: 1 }, {
-  apiId: 'getUserListWithConfig',
-  headers: {
-    'X-Custom-Header': 'custom-value'
-  },
-  timeout: 15000,
-  withCredentials: true,
-  responseType: 'json'
-})
-  .then(data => {
-    console.log('用户列表:', data);
-  })
-  .catch(error => {
-    console.error('获取用户列表失败:', error);
-  });
+# 简洁数据服务使用指南
+
+这个简洁数据服务提供了基本的数据操作方法，包括列表查询、详情查询、数据写入、数据修改、数据删除，每个方法都包含基础的API配置，包括apiId参数。**所有接口均使用POST方法提交**，包括查询接口。
+
+## 配置
+
+数据服务通过环境变量配置域名，支持以下环境变量：
+
+- `VUE_APP_API_BASE_URL`: 在Vue CLI项目中使用
+- `VITE_API_BASE_URL`: 在Vite项目中使用
+
+您可以在项目的`.env`文件中配置这些环境变量：
+
+```
+# .env.development
+VITE_API_BASE_URL=http://localhost:3000/api
+
+# .env.production
+VITE_API_BASE_URL=https://api.example.com
+```
+
+## 基本用法
+
+### 导入组件
+
+```javascript
+// 导入数据服务
+import { dataService } from '@ebiz/lowcode-components';
+```
+
+### 查询列表数据 (POST方法)
+
+```javascript
+// 查询用户列表
+dataService.queryList('/users/list', { page: 1, pageSize: 10 }, { apiId: 'getUserList' })
+  .then(data => {
+    console.log('用户列表:', data);
+  })
+  .catch(error => {
+    console.error('获取用户列表失败:', error);
+  });
+
+// 使用自定义API配置
+dataService.queryList('/users/list', { status: 'active' }, {
+  apiId: 'getActiveUsers',
+  headers: {
+    'X-Custom-Header': 'custom-value'
+  },
+  timeout: 10000
+})
+  .then(data => {
+    console.log('活跃用户列表:', data);
+  })
+  .catch(error => {
+    console.error('获取活跃用户列表失败:', error);
+  });
+```
+
+### 查询详情数据 (POST方法)
+
+```javascript
+// 查询用户详情
+dataService.queryDetail('/users/detail', '123', {}, { apiId: 'getUserDetail' })
+  .then(data => {
+    console.log('用户详情:', data);
+  })
+  .catch(error => {
+    console.error('获取用户详情失败:', error);
+  });
+
+// 查询用户详情，包含关联数据
+dataService.queryDetail('/users/detail', '123', { include: 'orders,profile' }, { apiId: 'getUserDetailWithRelations' })
+  .then(data => {
+    console.log('用户详情(包含关联数据):', data);
+  })
+  .catch(error => {
+    console.error('获取用户详情失败:', error);
+  });
+```
+
+### 新增数据 (POST方法)
+
+```javascript
+// 创建用户
+dataService.create('/users/create', {
+  name: '张三',
+  email: 'zhangsan@example.com',
+  role: 'user'
+}, { apiId: 'createUser' })
+  .then(data => {
+    console.log('创建用户成功:', data);
+  })
+  .catch(error => {
+    console.error('创建用户失败:', error);
+  });
+
+// 使用自定义API配置创建用户
+dataService.create('/users/create', {
+  name: '李四',
+  email: 'lisi@example.com',
+  role: 'admin'
+}, {
+  apiId: 'createAdminUser',
+  headers: {
+    'X-Admin-Create': 'true'
+  }
+})
+  .then(data => {
+    console.log('创建管理员用户成功:', data);
+  })
+  .catch(error => {
+    console.error('创建管理员用户失败:', error);
+  });
+```
+
+### 更新数据 (POST方法)
+
+```javascript
+// 更新用户
+dataService.update('/users/update', '123', {
+  name: '张三(已更新)',
+  email: 'zhangsan_updated@example.com'
+}, { apiId: 'updateUser' })
+  .then(data => {
+    console.log('更新用户成功:', data);
+  })
+  .catch(error => {
+    console.error('更新用户失败:', error);
+  });
+
+// 使用自定义API配置更新用户
+dataService.update('/users/update', '123', {
+  status: 'inactive'
+}, {
+  apiId: 'updateUserStatus',
+  headers: {
+    'X-Status-Update': 'true'
+  }
+})
+  .then(data => {
+    console.log('更新用户状态成功:', data);
+  })
+  .catch(error => {
+    console.error('更新用户状态失败:', error);
+  });
+```
+
+### 删除数据 (POST方法)
+
+```javascript
+// 删除用户
+dataService.delete('/users/delete', '123', {}, { apiId: 'deleteUser' })
+  .then(data => {
+    console.log('删除用户成功:', data);
+  })
+  .catch(error => {
+    console.error('删除用户失败:', error);
+  });
+
+// 软删除用户
+dataService.delete('/users/delete', '123', { soft: true }, { apiId: 'softDeleteUser' })
+  .then(data => {
+    console.log('软删除用户成功:', data);
+  })
+  .catch(error => {
+    console.error('软删除用户失败:', error);
+  });
+```
+
+### 批量操作 (POST方法)
+
+```javascript
+// 批量删除用户
+dataService.batch('/users/batch', 'delete', ['123', '456', '789'], {}, { apiId: 'batchDeleteUsers' })
+  .then(data => {
+    console.log('批量删除用户成功:', data);
+  })
+  .catch(error => {
+    console.error('批量删除用户失败:', error);
+  });
+
+// 批量更新用户状态
+dataService.batch('/users/batch', 'update', ['123', '456'], {
+  status: 'active'
+}, { apiId: 'batchUpdateUserStatus' })
+  .then(data => {
+    console.log('批量更新用户状态成功:', data);
+  })
+  .catch(error => {
+    console.error('批量更新用户状态失败:', error);
+  });
+```
+
+## 请求数据格式
+
+所有方法都使用POST方法提交数据，请求体格式如下：
+
+### 查询列表
+```json
+{
+  "page": 1,
+  "pageSize": 10,
+  "其他查询参数": "值"
+}
+```
+
+### 查询详情
+```json
+{
+  "id": "123",
+  "include": "orders,profile",
+  "其他查询参数": "值"
+}
+```
+
+### 新增数据
+```json
+{
+  "name": "张三",
+  "email": "zhangsan@example.com",
+  "role": "user",
+  "其他字段": "值"
+}
+```
+
+### 更新数据
+```json
+{
+  "id": "123",
+  "name": "张三(已更新)",
+  "email": "zhangsan_updated@example.com",
+  "其他字段": "值"
+}
+```
+
+### 删除数据
+```json
+{
+  "id": "123",
+  "soft": true,
+  "其他参数": "值"
+}
+```
+
+### 批量操作
+```json
+{
+  "action": "delete",
+  "ids": ["123", "456", "789"],
+  "其他参数": "值"
+}
+```
+
+## API配置选项
+
+每个方法都支持自定义API配置，常用的配置选项包括：
+
+| 配置项 | 类型 | 说明 |
+|-------|------|------|
+| apiId | String | API标识，用于标识请求的API |
+| headers | Object | 自定义请求头 |
+| timeout | Number | 请求超时时间(毫秒) |
+| withCredentials | Boolean | 是否携带凭证(cookies) |
+| responseType | String | 响应类型，如'json'、'blob'、'text'等 |
+
+示例：
+
+```javascript
+// 使用完整的API配置
+dataService.queryList('/users/list', { page: 1 }, {
+  apiId: 'getUserListWithConfig',
+  headers: {
+    'X-Custom-Header': 'custom-value'
+  },
+  timeout: 15000,
+  withCredentials: true,
+  responseType: 'json'
+})
+  .then(data => {
+    console.log('用户列表:', data);
+  })
+  .catch(error => {
+    console.error('获取用户列表失败:', error);
+  });
 ```