上传文件
- 接口地址:
/api/v2/common/upload-file
- 请求方式:
POST
- 传参方式:
multipart/form-data
Headers 可选参数
参数名 | 公开模式(是否必传) | 私有模式(是否必传) |
---|---|---|
X-Fresns-Aid | YES | YES |
X-Fresns-Aid-Token | YES | YES |
X-Fresns-Uid | YES | YES |
X-Fresns-Uid-Token | YES | YES |
Form-data 参数
参数名 | 类型 | 是否必传 | 说明 |
---|---|---|---|
usageType | Number | YES | 文件用途类型 |
tableName | String | YES | 来源表名users /api/v2/user/editposts comments conversation_messages /api/v2/conversation/send-messagepost_logs /api/v2/editor/{type}/{draftId}comment_logs /api/v2/editor/{type}/{draftId} |
tableColumn | String | YES | 来源字段名,默认填参 id |
tableId | Number | NO | 来源表主键 ID |
tableKey | String | NO | 来源表键名 |
type | String | YES | 四选一 image ,video ,audio ,document |
uploadMode | String | YES | 二选一file 上传文件fileInfo 上传文件信息 |
fileInfo | Array | NO | uploadMode=fileInfo 专用,上传文件信息数组 |
moreJson | Object | NO | uploadMode=file 专用,可选 |
file | File | NO | uploadMode=file 专用,上传文件 |
接口使用说明
- 参数 fileInfo 示例如下,参数类型可查看 files 表结构。
json
[
{
"name": "存储到 files->name",
"mime": "存储到 files->mime",
"extension": "存储到 files->extension",
"size": "存储到 files->size", // 单位 Byte
"md5": "存储到 files->md5",
"sha": "存储到 files->sha",
"shaType": "存储到 files->sha_type",
"disk": "存储到 files->disk",
"path": "存储到 files->path",
"imageHandlePosition": "存储到 files->image_handle_position",
"imageWidth": "图片专用,存储到 files->image_width",
"imageHeight": "图片专用,存储到 files->image_height",
"videoTime": "视频专用,存储到 files->video_time",
"videoPosterPath": "视频专用,存储到 files->video_poster_path",
"audioTime": "音频专用,存储到 files->audio_time",
"transcodingState": "音视频专用,存储到 files->transcoding_state",
"moreJson": {
// 扩展信息,存储到 files->more_json
},
"originalPath": "存储到 files->original_path",
"rating": "存储到 file_usages->rating",
}
]
返回结果
uploadMode = file
json
{
"code": 0,
"message": "ok",
"data": {
// 通用数据结构->文件信息
}
}
uploadMode = fileInfo
json
{
"code": 0,
"message": "ok",
"data": [
{
// 通用数据结构->文件信息
}
]
}