chore: add comment for api file

buqiyuan · May 11, 2024 · ba1a9b1 · ba1a9b1
1 parent 6bd5f3c
commit ba1a9b1
Show file tree

Hide file tree

Showing 25 changed files with 139 additions and 8 deletions.
diff --git a/openapi.config.ts b/openapi.config.ts
@@ -9,7 +9,13 @@ generateService({
   serversPath: './src/api/backend',
   requestOptionsType: 'RequestOptions',
   // 自定义网络请求函数路径
-  requestImportStatement: 'import { request, type RequestOptions } from "@/utils/request";',
+  requestImportStatement: `
+  /**
+   * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+   * */
+
+  import { request, type RequestOptions } from "@/utils/request";
+  `,
   hook: {
     afterOpenApiDataInited(openAPIData) {
       const schemas = openAPIData.components?.schemas;
@@ -60,13 +66,13 @@ generateService({
       const moduleName = operationObject.tags?.[0].split(' - ')[0];
 
       // 移除 query 参数的默认值
-      // operationObject.parameters?.forEach((param) => {
-      //   if ('in' in param && param.in === 'query' && param.schema) {
-      //     if (!('$ref' in param.schema) && param.schema.default) {
-      //       Reflect.deleteProperty(param.schema, 'default');
-      //     }
-      //   }
-      // });
+      operationObject.parameters?.forEach((param) => {
+        if ('in' in param && param.in === 'query' && param.schema) {
+          if (!('$ref' in param.schema) && param.schema.default) {
+            Reflect.deleteProperty(param.schema, 'default');
+          }
+        }
+      });
 
       if (moduleName === controllerName) {
         return [controllerName];

diff --git a/src/api/backend/api/account.ts b/src/api/backend/api/account.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 账户登出 GET /api/account/logout */

diff --git a/src/api/backend/api/auth.ts b/src/api/backend/api/auth.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 登录 POST /api/auth/login */

diff --git a/src/api/backend/api/authEmail.ts b/src/api/backend/api/authEmail.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 发送邮箱验证码 POST /api/auth/email/send */

diff --git a/src/api/backend/api/businessTodo.ts b/src/api/backend/api/businessTodo.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取Todo列表 GET /api/todos */

diff --git a/src/api/backend/api/captcha.ts b/src/api/backend/api/captcha.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取登录图片验证码 GET /api/auth/captcha/img */

diff --git a/src/api/backend/api/health.ts b/src/api/backend/api/health.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 此处后端没有提供注释 GET /api/health/database */

diff --git a/src/api/backend/api/netDiskManage.ts b/src/api/backend/api/netDiskManage.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 复制文件或文件夹，支持批量 POST /api/netdisk/manage/copy */

diff --git a/src/api/backend/api/netDiskOverview.ts b/src/api/backend/api/netDiskOverview.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取网盘空间数据统计 GET /api/netdisk/overview/desc */

diff --git a/src/api/backend/api/systemDept.ts b/src/api/backend/api/systemDept.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取部门列表 GET /api/system/depts */

diff --git a/src/api/backend/api/systemDictItem.ts b/src/api/backend/api/systemDictItem.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取字典项列表 GET /api/system/dict-item */

diff --git a/src/api/backend/api/systemDictType.ts b/src/api/backend/api/systemDictType.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取字典类型列表 GET /api/system/dict-type */

diff --git a/src/api/backend/api/systemEmail.ts b/src/api/backend/api/systemEmail.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 发送邮件 POST /api/tools/email/send */

diff --git a/src/api/backend/api/systemLog.ts b/src/api/backend/api/systemLog.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 查询验证码日志列表 GET /api/system/log/captcha/list */

diff --git a/src/api/backend/api/systemMenu.ts b/src/api/backend/api/systemMenu.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取所有菜单列表 GET /api/system/menus */

diff --git a/src/api/backend/api/systemOnline.ts b/src/api/backend/api/systemOnline.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 下线指定在线用户 POST /api/system/online/kick */

diff --git a/src/api/backend/api/systemParamConfig.ts b/src/api/backend/api/systemParamConfig.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取参数配置列表 GET /api/system/param-config */

diff --git a/src/api/backend/api/systemRole.ts b/src/api/backend/api/systemRole.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取角色列表 GET /api/system/roles */

diff --git a/src/api/backend/api/systemServe.ts b/src/api/backend/api/systemServe.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取服务器运行信息 GET /api/system/serve/stat */

diff --git a/src/api/backend/api/systemSse.ts b/src/api/backend/api/systemSse.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 服务端推送消息 GET /api/sse/${param0} */

diff --git a/src/api/backend/api/systemTask.ts b/src/api/backend/api/systemTask.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取任务列表 GET /api/system/tasks */

diff --git a/src/api/backend/api/systemUser.ts b/src/api/backend/api/systemUser.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 获取用户列表 GET /api/system/users */

diff --git a/src/api/backend/api/toolsStorage.ts b/src/api/backend/api/toolsStorage.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 删除文件 POST /api/tools/storage/delete */

diff --git a/src/api/backend/api/toolsUpload.ts b/src/api/backend/api/toolsUpload.ts
@@ -1,5 +1,10 @@
 // @ts-ignore
 /* eslint-disable */
+
+/**
+ * 该文件为 @umijs/openapi 插件自动生成，请勿随意修改。如需修改请通过配置 openapi.config.ts 进行定制化。
+ * */
+
 import { request, type RequestOptions } from '@/utils/request';
 
 /** 上传 POST /api/tools/upload */

diff --git a/src/api/backend/api/typings.d.ts b/src/api/backend/api/typings.d.ts
@@ -805,6 +805,16 @@ declare namespace API {
     pageSize?: number;
     field?: string;
     order?: 'ASC' | 'DESC';
+    /** 角色名称 */
+    name?: string;
+    /** 角色值 */
+    value?: string;
+    /** 角色备注 */
+    remark?: string;
+    /** 状态 */
+    status?: 0 | 1;
+    /** 关联菜单、权限编号 */
+    menuIds?: number[];
     _t?: number;
   };