Przeglądaj źródła

✨ feat(files): 新增文件列表查询响应schema

- 创建FileListSchema用于文件列表查询响应
- 从文件列表响应中排除用户密码字段
- 更新文件CRUD路由配置,使用FileListSchema作为列表响应schema
yourname 3 miesięcy temu
rodzic
commit
a540803002

+ 2 - 2
packages/server/src/api/files/index.ts

@@ -9,7 +9,7 @@ import { AuthContext } from '../../types/context';
 
 import { createCrudRoutes } from '../../utils/generic-crud.routes';
 import { File } from '../../modules/files/file.entity';
-import { FileSchema, CreateFileDto, UpdateFileDto } from '../../modules/files/file.schema';
+import { FileSchema, CreateFileDto, UpdateFileDto, FileListSchema } from '../../modules/files/file.schema';
 import { authMiddleware } from '../../middleware/auth.middleware';
 
 const fileRoutes = createCrudRoutes({
@@ -17,7 +17,7 @@ const fileRoutes = createCrudRoutes({
   createSchema: CreateFileDto,
   updateSchema: UpdateFileDto,
   getSchema: FileSchema,
-  listSchema: FileSchema,
+  listSchema: FileListSchema,
   searchFields: ['name', 'type', 'description'],
   relations: ['uploadUser'],
   middleware: [authMiddleware]

+ 53 - 0
packages/server/src/modules/files/file.schema.ts

@@ -89,4 +89,57 @@ export const UpdateFileDto = z.object({
     description: '文件描述',
     example: '2023年度项目计划书(修订版)'
   })
+});
+
+// 文件列表查询响应 schema(排除密码字段)
+export const FileListSchema = z.object({
+  id: z.number().int().positive().openapi({
+    description: '文件ID',
+    example: 1
+  }),
+  name: z.string().max(255).openapi({
+    description: '文件名称',
+    example: '项目计划书.pdf'
+  }),
+  type: z.string().max(50).nullable().openapi({
+    description: '文件类型',
+    example: 'application/pdf'
+  }),
+  size: z.number().int().positive().nullable().openapi({
+    description: '文件大小,单位字节',
+    example: 102400
+  }),
+  path: z.string().max(512).openapi({
+    description: '文件存储路径',
+    example: '/uploads/documents/2023/project-plan.pdf'
+  }),
+  fullUrl: z.url().openapi({
+    description: '完整文件访问URL',
+    example: 'https://minio.example.com/d8dai/uploads/documents/2023/project-plan.pdf'
+  }),
+  description: z.string().nullable().openapi({
+    description: '文件描述',
+    example: '2023年度项目计划书'
+  }),
+  uploadUserId: z.number().int().positive().openapi({
+    description: '上传用户ID',
+    example: 1
+  }),
+  uploadUser: UserSchema.omit({ password: true }),
+  uploadTime: z.coerce.date().openapi({
+    description: '上传时间',
+    example: '2023-01-15T10:30:00Z'
+  }),
+  lastUpdated: z.date().nullable().openapi({
+    description: '最后更新时间',
+    example: '2023-01-16T14:20:00Z'
+  }),
+  createdAt: z.coerce.date().openapi({
+    description: '创建时间',
+    example: '2023-01-15T10:30:00Z'
+  }),
+  updatedAt: z.coerce.date().openapi({
+    description: '更新时间',
+    example: '2023-01-16T14:20:00Z'
+  })
 });