refactor: ♻️ 字典调整按需加载，api、store和枚举文件命名优化

2025-03-24 08:17:31 +08:00
parent 6204deb7cb
commit 3c9cf67961
84 changed files with 989 additions and 1108 deletions
--- a/src/api/auth/index.ts
+++ b/src/api/auth/index.ts
--- a/src/api/codegen/index.ts
+++ b/src/api/codegen/index.ts
--- a/src/api/file/index.ts
+++ b/src/api/file/index.ts
--- a/src/api/system/config.api.ts
+++ b/src/api/system/config.api.ts
@@ -3,7 +3,7 @@ import request from "@/utils/request";
 const CONFIG_BASE_URL = "/api/v1/config";

 const ConfigAPI = {
-  /** 获取系统配置分页数据 */
+  /** 系统配置分页 */
  getPage(queryParams?: ConfigPageQuery) {
    return request<any, PageResult<ConfigPageVO[]>>({
      url: `${CONFIG_BASE_URL}/page`,
@@ -11,12 +11,8 @@ const ConfigAPI = {
      params: queryParams,
    });
  },
-  /**
-   * 获取系统配置表单数据
-   *
-   * @param id ConfigID
-   * @returns Config表单数据
-   */
+
+  /** 系统配置表单数据 */
  getFormData(id: number) {
    return request<any, ConfigForm>({
      url: `${CONFIG_BASE_URL}/${id}/form`,
@@ -24,8 +20,8 @@ const ConfigAPI = {
    });
  },

-  /** 添加系统配置*/
-  add(data: ConfigForm) {
+  /** 新增系统配置 */
+  create(data: ConfigForm) {
    return request({
      url: `${CONFIG_BASE_URL}`,
      method: "post",
@@ -33,12 +29,7 @@ const ConfigAPI = {
    });
  },

-  /**
-   * 更新系统配置
-   *
-   * @param id ConfigID
-   * @param data Config表单数据
-   */
+  /** 更新系统配置 */
  update(id: number, data: ConfigForm) {
    return request({
      url: `${CONFIG_BASE_URL}/${id}`,
--- a/src/api/system/dept.api.ts
+++ b/src/api/system/dept.api.ts
@@ -44,7 +44,7 @@ const DeptAPI = {
   * @param data 部门表单数据
   * @returns 请求结果
   */
-  add(data: DeptForm) {
+  create(data: DeptForm) {
    return request({
      url: `${DEPT_BASE_URL}`,
      method: "post",
--- a/src/api/system/dict-data.ts
+++ b/src/api/system/dict-data.ts
@@ -1,162 +0,0 @@
-import request from "@/utils/request";
-
-const DICT_DATA_BASE_URL = "/api/v1/dict-data";
-
-const DictDataAPI = {
-  /**
-   * 获取字典分页列表
-   *
-   * @param queryParams 查询参数
-   * @returns 字典分页结果
-   */
-  getPage(queryParams: DictDataPageQuery) {
-    return request<any, PageResult<DictDataPageVO[]>>({
-      url: `${DICT_DATA_BASE_URL}/page`,
-      method: "get",
-      params: queryParams,
-    });
-  },
-
-  /**
-   * 获取字典数据表单
-   *
-   * @param id 字典ID
-   * @returns 字典数据表单
-   */
-  getFormData(id: number) {
-    return request<any, ResponseData<DictDataForm>>({
-      url: `${DICT_DATA_BASE_URL}/${id}/form`,
-      method: "get",
-    });
-  },
-
-  /**
-   * 新增字典数据
-   *
-   * @param data 字典数据
-   */
-  add(data: DictDataForm) {
-    return request({
-      url: `${DICT_DATA_BASE_URL}`,
-      method: "post",
-      data: data,
-    });
-  },
-
-  /**
-   * 修改字典数据
-   *
-   * @param id 字典ID
-   * @param data 字典数据
-   */
-  update(id: number, data: DictDataForm) {
-    return request({
-      url: `${DICT_DATA_BASE_URL}/${id}`,
-      method: "put",
-      data: data,
-    });
-  },
-
-  /**
-   * 删除字典
-   *
-   * @param ids 字典ID，多个以英文逗号(,)分隔
-   */
-  deleteByIds(ids: string) {
-    return request({
-      url: `${DICT_DATA_BASE_URL}/${ids}`,
-      method: "delete",
-    });
-  },
-
-  /**
-   * 获取字典的数据项
-   *
-   * @param dictCode 字典编码
-   * @returns 字典数据项
-   */
-  getOptions(dictCode: string) {
-    return request<any, OptionType[]>({
-      url: `${DICT_DATA_BASE_URL}/${dictCode}/options`,
-      method: "get",
-    });
-  },
-};
-
-export default DictDataAPI;
-
-/**
- * 字典查询参数
- */
-export interface DictDataPageQuery extends PageQuery {
-  /** 关键字(字典数据值/标签) */
-  keywords?: string;
-
-  /** 字典编码 */
-  dictCode?: string;
-}
-
-/**
- * 字典分页对象
- */
-export interface DictDataPageVO {
-  /**
-   * 字典ID
-   */
-  id: number;
-  /**
-   * 字典编码
-   */
-  dictCode: string;
-  /**
-   * 字典数据值
-   */
-  value: string;
-  /**
-   * 字典数据标签
-   */
-  label: string;
-  /**
-   * 状态（1:启用，0:禁用)
-   */
-  status: number;
-  /**
-   * 字典排序
-   */
-  sort?: number;
-}
-
-/**
- * 字典
- */
-export interface DictDataForm {
-  /**
-   * 字典ID
-   */
-  id?: number;
-  /**
-   * 字典编码
-   */
-  dictCode?: string;
-  /**
-   * 字典数据值
-   */
-  value?: string;
-  /**
-   * 字典数据标签
-   */
-  label?: string;
-  /**
-   * 状态（1:启用，0:禁用)
-   */
-  status?: number;
-  /**
-   * 字典排序
-   */
-  sort?: number;
-
-  /**
-   * 标签类型
-   */
-  tagType?: "success" | "warning" | "info" | "primary" | "danger" | undefined;
-}
--- a/src/api/system/dict.api.ts
+++ b/src/api/system/dict.api.ts
@@ -0,0 +1,302 @@
+import request from "@/utils/request";
+
+const DICT_BASE_URL = "/api/v1/dicts";
+
+const DictAPI = {
+  //---------------------------------------------------
+  // 字典相关接口
+  //---------------------------------------------------
+
+  /**
+   * 字典分页列表
+   *
+   * @param queryParams 查询参数
+   * @returns 字典分页结果
+   */
+  getPage(queryParams: DictPageQuery) {
+    return request<any, PageResult<DictPageVO[]>>({
+      url: `${DICT_BASE_URL}/page`,
+      method: "get",
+      params: queryParams,
+    });
+  },
+
+  /**
+   * 字典表单数据
+   *
+   * @param id 字典ID
+   * @returns 字典表单数据
+   */
+  getFormData(id: number) {
+    return request<any, ResponseData<DictForm>>({
+      url: `${DICT_BASE_URL}/${id}/form`,
+      method: "get",
+    });
+  },
+
+  /**
+   * 新增字典
+   *
+   * @param data 字典表单数据
+   */
+  create(data: DictForm) {
+    return request({
+      url: `${DICT_BASE_URL}`,
+      method: "post",
+      data: data,
+    });
+  },
+
+  /**
+   * 修改字典
+   *
+   * @param id 字典ID
+   * @param data 字典表单数据
+   */
+  update(id: number, data: DictForm) {
+    return request({
+      url: `${DICT_BASE_URL}/${id}`,
+      method: "put",
+      data: data,
+    });
+  },
+
+  /**
+   * 删除字典
+   *
+   * @param ids 字典ID，多个以英文逗号(,)分隔
+   */
+  deleteByIds(ids: string) {
+    return request({
+      url: `${DICT_BASE_URL}/${ids}`,
+      method: "delete",
+    });
+  },
+
+  //---------------------------------------------------
+  // 字典项相关接口
+  //---------------------------------------------------
+  /**
+   * 获取字典分页列表
+   *
+   * @param queryParams 查询参数
+   * @returns 字典分页结果
+   */
+  getDictItemPage(dictCode: string, queryParams: DictItemPageQuery) {
+    return request<any, PageResult<DictItemPageVO[]>>({
+      url: `${DICT_BASE_URL}/${dictCode}/items/page`,
+      method: "get",
+      params: queryParams,
+    });
+  },
+
+  /**
+   * 获取字典项列表
+   */
+  getDictItems(dictCode: string) {
+    return request<any, DictItemOption[]>({
+      url: `${DICT_BASE_URL}/${dictCode}/items`,
+      method: "get",
+    });
+  },
+
+  /**
+   * 新增字典项
+   */
+  createDictItem(dictCode: string, data: DictItemForm) {
+    return request({
+      url: `${DICT_BASE_URL}/${dictCode}/items`,
+      method: "post",
+      data: data,
+    });
+  },
+
+  /**
+   * 获取字典项表单数据
+   *
+   * @param id 字典项ID
+   * @returns 字典项表单数据
+   */
+  getDictItemFormData(dictCode: string, id: number) {
+    return request<any, ResponseData<DictItemForm>>({
+      url: `${DICT_BASE_URL}/${dictCode}/items/${id}/form`,
+      method: "get",
+    });
+  },
+
+  /**
+   * 修改字典项
+   */
+  updateDictItem(dictCode: string, id: number, data: DictItemForm) {
+    return request({
+      url: `${DICT_BASE_URL}/${dictCode}/items/${id}`,
+      method: "put",
+      data: data,
+    });
+  },
+
+  /**
+   * 删除字典项
+   */
+  deleteDictItems(dictCode: string, ids: string) {
+    return request({
+      url: `${DICT_BASE_URL}/${dictCode}/items/${ids}`,
+      method: "delete",
+    });
+  },
+};
+
+export default DictAPI;
+
+/**
+ * 字典查询参数
+ */
+export interface DictPageQuery extends PageQuery {
+  /**
+   * 关键字(字典名称/编码)
+   */
+  keywords?: string;
+
+  /**
+   * 字典状态（1:启用，0:禁用）
+   */
+  status?: number;
+}
+
+/**
+ * 字典分页对象
+ */
+export interface DictPageVO {
+  /**
+   * 字典ID
+   */
+  id: number;
+  /**
+   * 字典名称
+   */
+  name: string;
+  /**
+   * 字典编码
+   */
+  dictCode: string;
+  /**
+   * 字典状态（1:启用，0:禁用）
+   */
+  status: number;
+}
+
+/**
+ * 字典
+ */
+export interface DictForm {
+  /**
+   * 字典ID
+   */
+  id?: number;
+  /**
+   * 字典名称
+   */
+  name?: string;
+  /**
+   * 字典编码
+   */
+  dictCode?: string;
+  /**
+   * 字典状态（1-启用，0-禁用）
+   */
+  status?: number;
+  /**
+   * 备注
+   */
+  remark?: string;
+}
+
+/**
+ * 字典查询参数
+ */
+export interface DictItemPageQuery extends PageQuery {
+  /** 关键字(字典数据值/标签) */
+  keywords?: string;
+
+  /** 字典编码 */
+  dictCode?: string;
+}
+
+/**
+ * 字典分页对象
+ */
+export interface DictItemPageVO {
+  /**
+   * 字典ID
+   */
+  id: number;
+  /**
+   * 字典编码
+   */
+  dictCode: string;
+  /**
+   * 字典数据值
+   */
+  value: string;
+  /**
+   * 字典数据标签
+   */
+  label: string;
+  /**
+   * 状态（1:启用，0:禁用)
+   */
+  status: number;
+  /**
+   * 字典排序
+   */
+  sort?: number;
+}
+
+/**
+ * 字典
+ */
+export interface DictItemForm {
+  /**
+   * 字典ID
+   */
+  id?: number;
+  /**
+   * 字典编码
+   */
+  dictCode?: string;
+  /**
+   * 字典数据值
+   */
+  value?: string;
+  /**
+   * 字典数据标签
+   */
+  label?: string;
+  /**
+   * 状态（1:启用，0:禁用)
+   */
+  status?: number;
+  /**
+   * 字典排序
+   */
+  sort?: number;
+
+  /**
+   * 标签类型
+   */
+  tagType?: "success" | "warning" | "info" | "primary" | "danger" | undefined;
+}
+
+/**
+ * 字典项下拉选项
+ */
+export interface DictItemOption {
+  /** 字典数据值 */
+  value: string;
+
+  /** 字典数据标签 */
+  label: string;
+
+  /** 标签类型 */
+  tagType: string;
+}
--- a/src/api/system/dict.ts
+++ b/src/api/system/dict.ts
@@ -1,180 +0,0 @@
-import request from "@/utils/request";
-
-const DICT_BASE_URL = "/api/v1/dict";
-
-const DictAPI = {
-  /**
-   * 获取字典分页列表
-   *
-   * @param queryParams 查询参数
-   * @returns 字典分页结果
-   */
-  getPage(queryParams: DictPageQuery) {
-    return request<any, PageResult<DictPageVO[]>>({
-      url: `${DICT_BASE_URL}/page`,
-      method: "get",
-      params: queryParams,
-    });
-  },
-
-  /**
-   * 获取字典表单数据
-   *
-   * @param id 字典ID
-   * @returns 字典表单数据
-   */
-  getFormData(id: number) {
-    return request<any, ResponseData<DictForm>>({
-      url: `${DICT_BASE_URL}/${id}/form`,
-      method: "get",
-    });
-  },
-
-  /**
-   * 新增字典
-   *
-   * @param data 字典表单数据
-   */
-  add(data: DictForm) {
-    return request({
-      url: `${DICT_BASE_URL}`,
-      method: "post",
-      data: data,
-    });
-  },
-
-  /**
-   * 修改字典
-   *
-   * @param id 字典ID
-   * @param data 字典表单数据
-   */
-  update(id: number, data: DictForm) {
-    return request({
-      url: `${DICT_BASE_URL}/${id}`,
-      method: "put",
-      data: data,
-    });
-  },
-
-  /**
-   * 删除字典
-   *
-   * @param ids 字典ID，多个以英文逗号(,)分隔
-   */
-  deleteByIds(ids: string) {
-    return request({
-      url: `${DICT_BASE_URL}/${ids}`,
-      method: "delete",
-    });
-  },
-
-  /**
-   * 获取字典列表
-   *
-   * @returns 字典列表
-   */
-  getList() {
-    return request<any, DictVO[]>({
-      url: `${DICT_BASE_URL}/list`,
-      method: "get",
-    });
-  },
-};
-
-export default DictAPI;
-
-/**
- * 字典查询参数
- */
-export interface DictPageQuery extends PageQuery {
-  /**
-   * 关键字(字典名称/编码)
-   */
-  keywords?: string;
-
-  /**
-   * 字典状态（1:启用，0:禁用）
-   */
-  status?: number;
-}
-
-/**
- * 字典分页对象
- */
-export interface DictPageVO {
-  /**
-   * 字典ID
-   */
-  id: number;
-  /**
-   * 字典名称
-   */
-  name: string;
-  /**
-   * 字典编码
-   */
-  dictCode: string;
-  /**
-   * 字典状态（1:启用，0:禁用）
-   */
-  status: number;
-}
-
-/**
- * 字典
- */
-export interface DictForm {
-  /**
-   * 字典ID
-   */
-  id?: number;
-  /**
-   * 字典名称
-   */
-  name?: string;
-  /**
-   * 字典编码
-   */
-  dictCode?: string;
-  /**
-   * 字典状态（1-启用，0-禁用）
-   */
-  status?: number;
-  /**
-   * 备注
-   */
-  remark?: string;
-}
-
-/**
- * 字典数据项分页VO
- *
- * @description 字典数据分页对象
- */
-export interface DictVO {
-  /** 字典名称 */
-  name: string;
-
-  /** 字典编码 */
-  dictCode: string;
-
-  /** 字典数据集合 */
-  dictDataList: DictData[];
-}
-
-/**
- * 字典数据
- *
- * @description 字典数据
- */
-export interface DictData {
-  /** 字典数据值 */
-  value: string;
-
-  /** 字典数据标签 */
-  label: string;
-
-  /** 标签类型 */
-  tagType: string;
-}
--- a/src/api/system/log.api.ts
+++ b/src/api/system/log.api.ts
--- a/src/api/system/menu.api.ts
+++ b/src/api/system/menu.api.ts
@@ -62,7 +62,7 @@ const MenuAPI = {
   * @param data 菜单表单数据
   * @returns 请求结果
   */
-  add(data: MenuForm) {
+  create(data: MenuForm) {
    return request({
      url: `${MENU_BASE_URL}`,
      method: "post",
@@ -101,7 +101,7 @@ const MenuAPI = {

 export default MenuAPI;

-import type { MenuTypeEnum } from "@/enums/MenuTypeEnum";
+import type { MenuTypeEnum } from "@/enums/system/menu.enum";

 /** 菜单查询参数 */
 export interface MenuQuery {
--- a/src/api/system/notice.api.ts
+++ b/src/api/system/notice.api.ts
@@ -31,7 +31,7 @@ const NoticeAPI = {
   * @param data Notice表单数据
   * @returns
   */
-  add(data: NoticeForm) {
+  create(data: NoticeForm) {
    return request({
      url: `${NOTICE_BASE_URL}`,
      method: "post",
--- a/src/api/system/role.api.ts
+++ b/src/api/system/role.api.ts
@@ -60,7 +60,7 @@ const RoleAPI = {
  },

  /** 添加角色 */
-  add(data: RoleForm) {
+  create(data: RoleForm) {
    return request({
      url: `${ROLE_BASE_URL}`,
      method: "post",
--- a/src/api/system/user.api.ts
+++ b/src/api/system/user.api.ts
@@ -46,7 +46,7 @@ const UserAPI = {
   *
   * @param data 用户表单数据
   */
-  add(data: UserForm) {
+  create(data: UserForm) {
    return request({
      url: `${USER_BASE_URL}`,
      method: "post",