修订自述文件

2025-10-27 17:58:38 +08:00
parent 4d0dba43bb
commit 1154c66e59
1 changed files with 184 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -19,6 +19,17 @@
   - 新增文章：`POST http://localhost:3000/api/articles`
   - 获取文章详情：`GET http://localhost:3000/api/articles/:id`
   - 获取文章列表：`GET http://localhost:3000/api/articles?isPublished=1&page=1&pageSize=20`
+   - 新增/更新视频：`POST http://localhost:3000/api/videos/:id`（`new` 或 `0` 为新建）
+   - 获取视频详情：`GET http://localhost:3000/api/videos/:id`
+   - 获取视频列表：`GET http://localhost:3000/api/videos?page=1&pageSize=10`
+   - 新增/更新文件：`POST http://localhost:3000/api/files/:id`（`new` 或 `0` 为新建）
+   - 获取文件详情：`GET http://localhost:3000/api/files/:id`
+   - 获取文件列表：`GET http://localhost:3000/api/files?page=1&pageSize=10`
+   - 精准服务新增/更新：`POST http://localhost:3000/api/precision-services/:id`（`new` 或 `0` 为新建）
+   - 精准服务详情：`GET http://localhost:3000/api/precision-services/:id`
+   - 精准服务列表：`GET http://localhost:3000/api/precision-services?page=1&pageSize=10`
+   - 单文件上传：`POST http://localhost:3000/api/upload`（字段名 `file`）
+   - 批量上传：`POST http://localhost:3000/api/uploads`（字段名 `files`）

 ## 说明

@@ -92,3 +103,176 @@
    }
    ```
  - 返回：`{ "success": true, "message": "文章下架成功" }`
+
+## 视频接口说明
+
+- 新建或更新视频
+  - `POST /api/videos/:id`
+  - 当 `:id` 为 `new` 或 `0` 时创建，否则更新对应 ID
+  - Body（JSON）示例：
+    ```json
+    {
+      "title": "示例视频",
+      "titleColor": "#000000",
+      "url": "https://example.com/page",
+      "author": "张三",
+      "publishTime": "2025-10-15T10:00:00Z",
+      "content": "简介...",
+      "articleNumber": "VID-2025-001",
+      "coverImage": "https://example.com/cover.jpg",
+      "videoUrl": "https://example.com/video.mp4",
+      "classification": "新闻",
+      "duration": "03:20",
+      "fileSize": "120MB",
+      "sortOrder": 10,
+      "viewCount": 0,
+      "isDraft": 0,
+      "isPublished": 1,
+      "isTop": 0,
+      "isRecommended": 0,
+      "isHot": 0,
+      "isSlideshow": 0,
+      "seoTitle": "SEO 标题",
+      "seoKeywords": "关键字1,关键字2",
+      "seoDescription": "SEO 描述"
+    }
+    ```
+- 获取视频详情
+  - `GET /api/videos/:id`
+- 获取视频列表
+  - `GET /api/videos?page=1&pageSize=10&title=示例&classification=新闻&isPublished=1`
+  - 支持筛选：`title`（模糊）、`classification`、`articleNumber`、`isPublished`、`isTop`、`isRecommended`、`isHot`、`isSlideshow`、`startTime`、`endTime`、`isDeleted`
+- 批量发布
+  - `POST /api/videos/publish`
+  - Body（JSON）示例：
+    ```json
+    [1, 2, 3]
+    ```
+  - 返回：`{ "success": true, "message": "成功发布 X 个视频" }`
+- 批量取消发布
+  - `POST /api/videos/unpublish`
+  - Body（JSON）示例：
+    ```json
+    [1, 2, 3]
+    ```
+  - 返回：`{ "success": true, "message": "成功取消发布 X 个视频" }`
+- 删除/恢复/物理删除
+  - 逻辑删除：`DELETE /api/videos/:id`
+  - 恢复：`POST /api/videos/recover/:id`
+  - 物理删除：`DELETE /api/videos/force/:id`
+
+## 文件接口说明
+
+- 新建或更新文件
+  - `POST /api/files/:id`
+  - 当 `:id` 为 `new` 或 `0` 时创建，否则更新对应 ID
+  - Body（JSON）示例（字段可按需传入）：
+    ```json
+    {
+      "title": "资料标题",
+      "titleColor": "#000000",
+      "fileName": "资料.pdf",
+      "attachmentUrl": "https://example.com/files/xxx.pdf",
+      "fileSize": "3.5MB",
+      "uploader": "管理员",
+      "url": "https://example.com/page",
+      "uploadTime": "2025-10-15T10:00:00Z",
+      "publishTime": "2025-10-15T10:00:00Z",
+      "description": "详细描述...",
+      "displayImage": "https://example.com/cover.jpg",
+      "sortNumber": 10,
+      "viewCount": 0,
+      "downloadCount": 0,
+      "isDraft": 0,
+      "isPublished": 1,
+      "isTop": 0,
+      "isRecommended": 0,
+      "isHot": 0,
+      "isSlideshow": 0,
+      "seoTitle": "SEO 标题",
+      "seoKeywords": "关键字1,关键字2",
+      "seoDescription": "SEO 描述"
+    }
+    ```
+- 获取文件详情
+  - `GET /api/files/:id`
+- 获取文件列表
+  - `GET /api/files?page=1&pageSize=10&title=资料&isPublished=1`
+  - 支持筛选：`title`（模糊）、`uploader`、`isDraft`、`isPublished`、`isTop`、`isRecommended`、`isHot`、`isSlideshow`、`startTime`、`endTime`、`isDeleted`
+- 批量发布/取消发布
+  - 发布：`POST /api/files/publish`，Body 示例：`[1,2,3]`
+  - 取消发布：`POST /api/files/unpublish`，Body 示例：`[1,2,3]`
+- 删除/恢复/物理删除
+  - 逻辑删除：`DELETE /api/files/:id`
+  - 恢复：`POST /api/files/recover/:id`
+  - 物理删除：`DELETE /api/files/force/:id`
+- 导出
+  - `GET /api/files/export?format=xlsx|csv|json&isPublished=1`
+  - 保留筛选条件导出；文件名自动按日期生成
+- 导入
+  - `POST /api/files/import`
+  - 表单字段：`file`（支持 `.xlsx/.csv/.json`）
+  - 最少字段要求：`title` 与 `attachmentUrl`
+  - 返回：`{ success, message, total, inserted, updated, errors }`
+
+## 精准服务接口说明
+
+- 新建或更新
+  - `POST /api/precision-services/:id`
+  - 当 `:id` 为 `new` 或 `0` 时创建，否则更新对应 ID
+  - Body（JSON）示例（与前端表单一致）：
+    ```json
+    {
+      "name": "张三",
+      "gender": 1,
+      "phone": "13800000001",
+      "birthDate": "1950-05-12",
+      "nation": "汉族",
+      "workStartDate": "1970-08-01",
+      "partyJoinDate": "1978-06-15",
+      "currentBenefit": "离休干部待遇",
+      "retirementInfo": "原某单位科长",
+      "selfCare": 2,
+      "livingCondition": "与家人同住",
+      "address": "北京市朝阳区XX路XX号",
+      "contact": "李四",
+      "contactPhone": "13900000002"
+    }
+    ```
+- 获取详情
+  - `GET /api/precision-services/:id`
+- 获取列表
+  - `GET /api/precision-services?page=1&pageSize=10&name=张&gender=1&isDeleted=0`
+  - 支持筛选：`name`（模糊）、`phone`（模糊）、`gender`、`nation`、`selfCare`、`isDeleted`
+- 删除/恢复/物理删除
+  - 逻辑删除：`DELETE /api/precision-services/:id`
+  - 恢复：`POST /api/precision-services/recover/:id`
+  - 物理删除：`DELETE /api/precision-services/force/:id`
+  - 备注：更新时间统一字段为 `updateTime`
+
+## 上传接口说明
+
+- 单文件上传
+  - `POST /api/upload`
+  - 表单字段：`file`
+  - 可选参数（query 或 form）：
+    - `dir` 上传子目录（仅允许 `-_/a-zA-Z0-9`）
+    - `prefix` 文件名前缀
+    - `keepName` 是否保留原始文件名的一部分（默认 `false`）
+  - 返回示例：
+    ```json
+    {
+      "success": true,
+      "url": "http://localhost:3000/upload/2025-10/xxxxxx.png",
+      "path": "/upload/2025-10/xxxxxx.png",
+      "filename": "xxxxxx.png",
+      "originalName": "origin.png",
+      "size": 12345,
+      "mimeType": "image/png"
+    }
+    ```
+- 批量上传
+  - `POST /api/uploads`
+  - 表单字段：`files`
+  - 返回：`{ success: true, files: [{ url, path, filename, originalName, size, mimeType }, ...] }`
+  - 静态访问：`/upload` 路径下可直接访问已上传文件