# tz-resource

**Repository Path**: tai-chi-data-engine/tz-resource

## Basic Information

- **Project Name**: tz-resource
- **Description**: 太极数据引擎-资源模块
https://sunkaiyan.cn/
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-09-13
- **Last Updated**: 2025-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 一、资源模块介绍

​		该子系统为物理层模块，是整个太极数据引擎的一部分。资源模块职责：文件上传下载、图像识别、临时资源定期清理，以及实现本地资源库。



# 二、API文档

## 2.1、上传文件



> **接口URL**：

```
GET /api/resource/upload_file
```

> **Query 请求参数**

| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明                 |
| ------ | ------ | -------- | -------- | ------------------------ |
| *file* | `true` | 是       | String   | `是否需要分页true/false` |

> **请求结果示例**

```json
{
	"err": 0,
	"data": {
		"filename": "2301948228054825.jpg",
		"url": "https://spss.tzengine.cn/tz_media/upload/2023-12/2301948228054825.jpg",
		"suffix": "jpg",
		"size": 556767,
		"md5": "DVPL6+3HJJ7Y85z6hZbrKw==",
		"snapshot": {
			"origin_filename": "pexels-luis-gomes-546819.jpg",
			"upload_host": "https://spss.tzengine.cn",
			"upload_url": "/tz_media/upload/2023-12/"
		},
		"title": "",
		"group_id": null,
		"user_id": 1,
		"id": 4
	},
	"msg": "ok"
}
```



## 2.2、文件列表

> **接口URL**：

```
POST /api/resource/get_files
```



> params 请求参数

```json
{
	"created_at_start": "", // 创建起始时间
	"created_at_end": "", // 创建结束时间
	"suffix": "", // 文件类型
	"title": ""  // 文件标题
}
```



> 请求结果示例

```json
{
	"err": 0,
	"data": {
		"count": 4,
		"page": 1,
		"size": 10,
		"list": [
			{
				"created_at": "2023-12-07 19:23:49",
				"updated_at": "2023-12-07 19:23:49",
				"group_id": null,
				"user_id": 1,
				"title": "",
				"url": "https://spss.tzengine.cn/tz_media/upload/2023-12/2301948228054825.jpg",
				"filename": "2301948228054825.jpg",
				"suffix": "jpg",
				"size": 556767,
				"md5": "DVPL6+3HJJ7Y85z6hZbrKw=="
			}
		]
	},
	"msg": "ok"
}
```





# 三、安装方式

> 拉取主项目

```powershell
git clone https://gitee.com/wanfengwenhua/tz-data-engine.git
```



> 安装配置配置子系统

```
pip install tz-dictionary -i http://tzengine.com/simple
```



> 运行太极数据引擎

```
python manage.py runserver
```



> 配置模块的配置

```
[xj_resource]
file_host =
file_types = doc,docx,els,elsx,pdf,md,jpg,jpeg,gif,png,svg
max_upload_size = 524288000
```