created

src/api/system/dict.ts

@@ -0,0 +1,305 @@
+import request from "@/utils/request";
+
+const DICT_BASE_URL = "/api/v1/dicts";
+
+const DictAPI = {
+  //---------------------------------------------------
+  // 字典相关接口
+  //---------------------------------------------------
+
+  /**
+   * 字典分页列表
+   *
+   * @param queryParams 查询参数
+   * @returns 字典分页结果
+   */
+  getPage(queryParams: DictPageQuery) {
+    return request<PageResult<DictPageVO[]>>({
+      url: `${DICT_BASE_URL}/page`,
+      method: "GET",
+      data: queryParams,
+    });
+  },
+
+  /**
+   * 字典表单数据
+   *
+   * @param id 字典ID
+   * @returns 字典表单数据
+   */
+  getFormData(id: number) {
+    return request<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<PageResult<DictItemPageVO[]>>({
+      url: `${DICT_BASE_URL}/${dictCode}/items/page`,
+      method: "GET",
+      data: queryParams,
+    });
+  },
+
+  /**
+   * 获取字典项列表
+   */
+  getDictItems(dictCode: string) {
+    return request<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<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 | number;
+
+  /** 字典数据标签 */
+  label: string;
+
+  /** 标签类型 */
+  tagType?: "" | "success" | "info" | "warning" | "danger" | "primary";
+
+  /** 允许其他属性 */
+  [key: string]: any;
+}