简要描述:
- 上传接口使用表单方式进行提交
- 上传接口实现文件、图片上传
接口版本:
版本号 | 制定人 | 制定日期 | 修订日期 |
---|---|---|---|
v3 | 陈碧贵 | 2022-05-20 | xxxx-xx-xx |
请求URL:
http://{url参数}/bo/api/v3/file/upload?_nodejs=common-data
http://localhost:58582/bo/api/v3/file/upload?_nodejs=common-data
- {mkey} 对应mapper文件
- {resField} 对应 {mkey}里面 responseField键
请求方式:
- POST
请求头:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
XownerId | 是 | string | 项目唯一ID,对应bo_project {ownerId} |
XsysId | 否 | string | 所属系统 对应 bo_system 表 |
XuserFromFirstShareId | string | 否 | 一级分享用户ID, bo_user user_id |
XuserFromSecondShareId | string | 否 | 二级分享用户ID, bo_user user_id |
XverifyApi | 是 | string | 加密规则encryptByDES(`${newGuid()} |
XfilterAreaCode | 否 | string | 行政区编码, 对应 bo_sys_area area_code |
Content-Type: | 是 | string | multipart/form-data;charset=utf-8 请求类型 |
Authorization | 是 | string | 当前用户认证信息,通过登录接口获取 Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6 |
请求参数:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
_nodejs | 是 | string | common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线 |
objectId | 是 | string | 主表对象主键 |
objectType | 是 | string | 主表对象名,如表名小写 |
body 请求参数:
form-data
返回示例:
正确时返回:
{
data: [
{
batO: "i",
id: 0,
name: "6360989299915820312405158.jpg",
url:
"http://localhost:58582/filelibary/rg/image/20210122/rg-deve-rg-20200-7af1b65f-3bab-428a_show.jpg",
suffix: "jpg",
size: 63541,
sizeKb: 62,
sizeMb: 0.06,
modifyTimeStamp: 1580895403575,
modifyDate: "2020-02-05T17:36:43",
},
],
code: 0,
success: true,
}
错误时返回:
{
"code": 0,
"message": ""
"error":{
errorCode:null,
errorText:null
}
"success": false,
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
success | bool | true 表示数据请求成功(跟code=0一致),调用者优先使用 |
code | int | true 表示数据请求成功(跟code=0一致),调用者优先使用 |
data | object | 响应的结果数据 Name:文件名 url:存储到服务器后的地址 suffix:后缀名 |
cacheType | string | redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化) |
cacheDate | date | 最后数据获取时间 |
文档更新时间: 2023-11-22 22:18 作者:admin