Skip to content
页面梗概

助力生态可持续发展

赞助 Fresns 发展

成为赞助者

上传文件

  • 接口地址:/api/v2/common/upload-file
  • 请求方式:POST
  • 传参方式:multipart/form-data

Headers 可选参数

参数名公开模式(是否必传)私有模式(是否必传)
aidYESYES
uidYESYES
tokenYESYES

Form-data 参数

参数名类型是否必传说明
usageTypeNumberYES参见数据库文件用途类型
tableNameStringYES来源表名
tableColumnStringYES来源字段名,默认为 id
tableIdNumberNO来源表主键 ID
tableKeyStringNO来源表键名
tableName=configs 传参 configs -> item_key
tableName=accounts 传参 accounts -> aid
tableName=users 传参 users -> uid 或 username
tableName=posts 传参 posts -> pid
tableName=comments 传参 comments -> cid
tableName=extends 传参 extends -> eid
tableName=groups 传参 groups -> gid
tableName=hashtags 传参 hashtags -> slug
typeStringYES四选一 image,video,audio,document
uploadModeStringYES二选一
file 上传文件
fileInfo 上传文件信息
fileInfoArrayNOuploadMode=fileInfo 专用,上传文件信息数组
moreJsonObjectNOuploadMode=file 专用,可选
fileFileNOuploadMode=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",
        "path": "存储到 files > path",
        "imageWidth": "图片专用,存储到 files > image_width",
        "imageHeight": "图片专用,存储到 files > image_height",
        "videoTime": "视频专用,存储到 files > video_time",
        "videoCoverPath": "视频专用,存储到 files > video_cover_path",
        "videoGifPath": "视频专用,存储到 files > video_gif_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": [
        {
            // 通用数据结构->文件信息
        }
    ]
}