小文件（集成）

-小文件-使用手册

小文件（集成）

小文件-使用手册

奕河最后一次编辑

3 年多前 90

小文件服务

引入第三方平台七牛云，提供小文件的存储服务，实现海量数据的存储和管理，对进行文件的上传、下载和管理。

swagger访问地址：

dev：https://dev.utcook.com/smallfile/swagger-ui.html

uat：http://uat.utcook.com/smallfile/swagger-ui.html

prd：http://www.utcook.com/smallfile/swagger-ui.html

序号	接口名称	接口描述	版本
七牛云空间配置
1	新增七牛云存储空间配置	POST： /smallfile/qiniu/qiniuConfig	V1.00
2	获取七牛云存储空间配置列表	GET： /smallfile/qiniu/qiniuConfig	V1.00
3	删除七牛云存储空间配置	POST： /smallfile/qiniu/qiniuConfig	V1.00
七牛云对象存储
4	后端直传	POST： /smallfile/qiniu/server_upload	V1.00
5	获取前端直传授权token	GET： /smallfile/qiniu/client_upload_key	V1.00
6	后端直传	获取到的私有空间对象访问路径是有时效限制的，建议访问私有对象时，均调用本接口获取最新的访问路径。GET： /smallfile/qiniu/private_image_view_url	V1.00

基本信息

Path：/smallfile/qiniu/qiniuConfig

Method： POST

接口描述：

该接口由基础平台为应用开通存储空间后调用

请求参数

Headers

参数名	是否必须	类型	说明
Content-Type	是	string	请求类型： application/json

Body

参数名	是否必须	类型	说明
appKey	是	string	应用key
appName	是	string	应用名称
accessKey	是	string	七牛云账户ak
secretKey	是	string	七牛云账户sk
bucketType	是	string	存储空间类型：0=公有，1=私有
bucketName	是	string	存储空间名称
bucketHost	是	string	存储空间host路径

返回参数

参数名	类型	说明
id	long	主键
appKey	string	应用key
appName	string	应用名称
accessKey	string	七牛云账户ak
secretKey	string	七牛云账户sk
bucketType	string	存储空间类型：0=公有，1=私有
bucketName	string	存储空间名称
bucketHost	string	存储空间host路径

基本信息

Path：/smallfile/qiniu/qiniuConfig

Method： GET

接口描述：

请求参数

返回参数

[
  {
    "id": 1,
    "appKey": "kitchen",
    "appName": "智能厨房",
    "accessKey": "C9mMCiPrmzQ5LTLIiYaAy8WlJMpPINCeD2wxOUSi",
    "secretKey": "LNv3l-Pt-Z1KXLUoR_mQuoCSsXUhy-aTybBLLzZz",
    "bucketType": "0",
    "bucketName": "kitchen-public",
    "bucketHost": "http://qiniu-pub.utcook.com"
  },
  {
    "id": 3,
    "appKey": "kitchen",
    "appName": "智能厨房",
    "accessKey": "C9mMCiPrmzQ5LTLIiYaAy8WlJMpPINCeD2wxOUSi",
    "secretKey": "LNv3l-Pt-Z1KXLUoR_mQuoCSsXUhy-aTybBLLzZz",
    "bucketType": "1",
    "bucketName": "kitchen-private",
    "bucketHost": "http://qiniu-prv.utcook.com"
  }
]

基本信息

Path：/smallfile/qiniu/qiniuConfig

Method： DELETE

接口描述：

请求参数

Headers

参数名	是否必须	类型	说明
Content-Type	是	string	请求类型： application/json

Body

参数名	是否必须	类型	说明
id	是	long	配置主键

返回参数

基本信息

Path：/smallfile/qiniu/server_upload

Method： POST

接口描述：

请求参数

Headers

参数名	是否必须	类型	说明
Content-Type	是	string	请求类型： x-www-form-urlencoded

Body

请求参数

参数名	类型	说明
host	string	存储空间host
hash	string	存储对象hash值
key	string	对象key（对象上传时若未指定名字，该值即为hash值）

基本信息

Path：/smallfile/qiniu/client_upload_key

Method： GET

接口描述：

若使用对象覆盖场景，获取token时指定的fileName要与前端调用七牛接口时指定的fileName一致
若使用对象覆盖场景，获取最新对象时，建议路径后面加上随机值（如当前时间戳），以刷新CDN缓存，否则可能出现已使用新对象覆盖，但获取回来的是旧对象。 eg：https://dev-pub-catering.utcook.com/1553494090000.jpg?v={时间戳} 参考文档：https://developer.qiniu.com/fusion/kb/1325/refresh-the-cache-and-the-effect-of-time

请求参数

Headers

参数名	是否必须	类型	说明
Content-Type	是	string	请求类型： x-www-form-urlencoded

Query

参数名	是否必须	类型	说明
fileName	否	String	可选，指定时，同名对象会被最近一次上传覆盖
appKey	是	String	应用key
isPrivateBucket	否	boolean	是否使用私有空间（不指定默认使用公共空间）

返回参数

参数名	类型	说明
host	string	存储空间host
token	string	授权客户端上传token

基本信息

Path：/smallfile/qiniu/client_upload_key

Method： GET

接口描述：

获取到的私有空间对象访问路径是有时效限制的，建议访问私有对象时，均调用本接口获取最新的访问路径。

请求参数

Headers

参数名	是否必须	类型	说明
Content-Type	是	string	请求类型： x-www-form-urlencoded

Query

参数名	是否必须	类型	说明
appKey	是	String	应用key
objectKey	是	String	私有空间对象key
expires	否	long	有效时长，单位秒，默认3600s

返回参数

参数名	类型	说明
privateImgViewUrl	string	私有空间对象访问路径

七牛云官方-图片基本处理api

示例

图片原图访问路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn
若要按200*200限定宽高等比缩放，则使用模式：imageView2/2/w/200/h/200/q/75
图片缩略图访问方式： http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn?imageView2/2/w/200/h/200/q/75

七牛云官方-图片高级处理api

示例

图片原图访问路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn
若要执行按20%等比缩放图片，则使用模式：imageMogr2/thumbnail/!20p
图片缩略图访问方式： http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn?imageMogr2/thumbnail/!20p

七牛云官方-图片水印处理api说明文档

示例

图片原图访问路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn
水印图片原路径：http://qiniu-pub.utcook.com/utcookLogo.png
水印图片原路径base64编码：aHR0cDovL3Fpbml1LXB1Yi51dGNvb2suY29tL3V0Y29va0xvZ28ucG5n
图片水印效果： http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn

七牛云官方-图片基本信息api

示例

图片原图访问路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn
获取图片信息路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn?imageInfo
响应结果：

{
    "size": 435194,
    "format": "jpeg",
    "width": 1280,
    "height": 1920,
    "colorModel": "ycbcr"
}

七牛云官方-图片EXIF信息api

示例

图片原图访问路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn
获取图片exif路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn?exif
响应结果：

{
    "ColorSpace": 
    {
    "val": "sRGB",
    "type": 3
    },
    "Copyright": 
    {
        "val": "CAOHONGJUN (Photographer) - (Editor)",
        "type": 2
    },
    "ExifVersion": 
    {
        "val": "Unknown Exif Version",
        "type": 7
    },
    "FlashPixVersion":
    {
        "val": "FlashPix Version 1.0",
        "type": 7
    },
    "ResolutionUnit": 
    {
        "val": "Inch",
        "type": 3
    },
    "XResolution":
    {
        "val": "300",
        "type": 5
    },
    "YResolution":
    {
        "val": "300",
        "type": 5
    }
}

七牛云官方-图片平均色调api

示例

图片原图访问路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn
获取图片平均色调路径：http://qiniu-pub.utcook.com/FmRN-tWeF127TH5Q_cs4Lsr62NGn?imageAve
响应结果：

{"RGB": "0xa85f67"}

日期	修改描述	作者
2019-7-28	初版发布	平台产品部

日期	修改描述
2019-7-28	发布小文件服务，创建小文件服务的用户使用手册

小文件-使用手册

奕河最后一次编辑

组件介绍

API 参考

API 列表（共6个）

七牛云空间配置

新增七牛云存储空间配置

获取七牛云存储空间配置列表

删除七牛云存储空间配置

七牛云对象存储

后端直传

获取前端直传授权token

后端直传

七牛云图片处理

产品版本

更新日志