refactor: ♻️ aPI 路径基础 URL 提取

src/api/dict/index.ts

@@ -8,28 +8,32 @@ import {
   DictPageResult,
 } from "./model";
 
+const DICT_BASE_URL = "/api/v1/dict";
+
 class DictAPI {
   /**
-   * 字典类型分页列表
+   * 获取字典类型分页列表
    *
-   * @param queryParams
+   * @param queryParams 查询参数
+   * @returns 字典类型分页结果
    */
   static getDictTypePage(queryParams: DictTypeQuery) {
     return request<any, DictTypePageResult>({
-      url: "/api/v1/dict/types/page",
+      url: `${DICT_BASE_URL}/types/page`,
       method: "get",
       params: queryParams,
     });
   }
 
   /**
-   * 字典类型表单数据
+   * 获取字典类型表单数据
    *
-   * @param id
+   * @param id 字典类型ID
+   * @returns 字典类型表单数据
    */
   static getDictTypeForm(id: number) {
     return request<any, ResponseData<DictTypeForm>>({
-      url: "/api/v1/dict/types/" + id + "/form",
+      url: `${DICT_BASE_URL}/types/${id}/form`,
       method: "get",
     });
   }
@@ -37,11 +41,12 @@ class DictAPI {
   /**
    * 新增字典类型
    *
-   * @param data
+   * @param data 字典类型表单数据
+   * @returns 请求结果
    */
   static addDictType(data: DictTypeForm) {
     return request({
-      url: "/api/v1/dict/types",
+      url: `${DICT_BASE_URL}/types`,
       method: "post",
       data: data,
     });
@@ -50,12 +55,13 @@ class DictAPI {
   /**
    * 修改字典类型
    *
-   * @param id
-   * @param data
+   * @param id 字典类型ID
+   * @param data 字典类型表单数据
+   * @returns 请求结果
    */
   static updateDictType(id: number, data: DictTypeForm) {
     return request({
-      url: "/api/v1/dict/types/" + id,
+      url: `${DICT_BASE_URL}/types/${id}`,
       method: "put",
       data: data,
     });
@@ -63,10 +69,13 @@ class DictAPI {
 
   /**
    * 删除字典类型
+   *
+   * @param ids 字典类型ID，多个以英文逗号(,)分隔
+   * @returns 请求结果
    */
   static deleteDictTypes(ids: string) {
     return request({
-      url: "/api/v1/dict/types/" + ids,
+      url: `${DICT_BASE_URL}/types/${ids}`,
       method: "delete",
     });
   }
@@ -75,20 +84,24 @@ class DictAPI {
    * 获取字典类型的数据项
    *
    * @param typeCode 字典类型编码
+   * @returns 字典类型的数据项
    */
   static getDictOptions(typeCode: string) {
     return request<any, OptionType[]>({
-      url: "/api/v1/dict/" + typeCode + "/options",
+      url: `${DICT_BASE_URL}/${typeCode}/options`,
       method: "get",
     });
   }
 
   /**
-   * 字典分页列表
+   * 获取字典分页列表
+   *
+   * @param queryParams 查询参数
+   * @returns 字典分页结果
    */
   static getDictPage(queryParams: DictQuery) {
     return request<any, DictPageResult>({
-      url: "/api/v1/dict/page",
+      url: `${DICT_BASE_URL}/page`,
       method: "get",
       params: queryParams,
     });
@@ -97,11 +110,12 @@ class DictAPI {
   /**
    * 获取字典表单数据
    *
-   * @param id
+   * @param id 字典项ID
+   * @returns 字典表单数据
    */
   static getDictFormData(id: number) {
     return request<any, DictForm>({
-      url: "/api/v1/dict/" + id + "/form",
+      url: `${DICT_BASE_URL}/${id}/form`,
       method: "get",
     });
   }
@@ -109,11 +123,12 @@ class DictAPI {
   /**
    * 新增字典
    *
-   * @param data
+   * @param data 字典表单数据
+   * @returns 请求结果
    */
   static addDict(data: DictForm) {
     return request({
-      url: "/api/v1/dict",
+      url: `${DICT_BASE_URL}`,
       method: "post",
       data: data,
     });
@@ -122,12 +137,13 @@ class DictAPI {
   /**
    * 修改字典项
    *
-   * @param id
-   * @param data
+   * @param id 字典项ID
+   * @param data 字典表单数据
+   * @returns 请求结果
    */
   static updateDict(id: number, data: DictForm) {
     return request({
-      url: "/api/v1/dict/" + id,
+      url: `${DICT_BASE_URL}/${id}`,
       method: "put",
       data: data,
     });
@@ -136,11 +152,12 @@ class DictAPI {
   /**
    * 删除字典
    *
-   * @param ids 字典项ID，多个以英文逗号(,)分割
+   * @param ids 字典项ID，多个以英文逗号(,)分隔
+   * @returns 请求结果
    */
   static deleteDictByIds(ids: string) {
     return request({
-      url: "/api/v1/dict/" + ids,
+      url: `${DICT_BASE_URL}/${ids}`,
       method: "delete",
     });
   }