1. hapir接口说明

1.1. 文档说明

Hapir服务提供了文件上传存储,文件读取的能力

1.2. 修订记录

日期 文档版本 修订内容 修改人
2020-09-18 v0.1 新建文档模板 Ken
2020-11-11 v1.0 初版Hapir接口文档 zhang

1.3. 接口约定

规则 描述
服务器域名(IP) 以部署为准,如: https://xxx.mixiot.top
接口鉴权 令牌机制,详情请阅接口鉴权
字符编码 统一采用UTF-8编码
响应格式 统一采用JSON格式

1.4. 响应说明

1.4.1. 返回码

code 含义 备注
200 请求成功 Code不为200,则说明请求失败
500 请求错误 -

1.4.2. 格式

1.单条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{}
}

2.多条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{
        "page_index":1,
        "page_size":20,
        "total_pages":0,
        "total_records":0,
        "data":[]
    }
}

1.5. 接口详细

1.5.1. 上传文件

请求地址:

属性
URL api/v1/file/upload
Method post
Content-Type multipart/form-data

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
file file 文件类型 选择的上传文件
system string 非空字符串 indass 文件对应的系统

响应参数:

参数名称 数据类型 描述
code int 返回码
msg string 提示消息
result object 返回结果
+ url string 可访问文件的网址
+ system string 文件对应系统
+ full_name string 文件原名
+ file_type string 文件类型
+ file_path string 文件物理存储路径
+ updated_at date 更新时间
+ created_at date 创建时间
+ file_id int 主键id

返回示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": {
        "url": "http://apir.fidis.com/storage/indass\\2020\\11\\11/fe3QzKEFdmFl4FtPonUJpEJf1FefcRpe5HORHcFk.pdf",
        "system": "indass",
        "full_name": "IMC第三方应用集成手册20201029.pdf",
        "file_type": "pdf",
        "file_path": "indass\\2020\\11\\11/fe3QzKEFdmFl4FtPonUJpEJf1FefcRpe5HORHcFk.pdf",
        "updated_at": "2020-11-11 15:35:09",
        "created_at": "2020-11-11 15:35:09",
        "file_id": 5
    }
}

1.5.2. 更新上传信息

请求地址:

属性
URL api/v1/file/update-file-record
Method post
Content-Type multipart/form-data

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
file_id int 必须是数据库中已存在的文件记录id 1 apir_file_record的主键id
nick_name string - 测试昵称 文件新的昵称
full_name string - 测试全称 文件新的原名

响应参数:

参数名称 数据类型 描述
code int 返回码
msg string 提示消息
result object 返回结果
+ url string 可访问文件的网址
+ system string 文件对应系统
+ full_name string 文件原名
+ nick_name string 文件昵称
+ file_type string 文件类型
+ file_path string 文件物理存储路径
+ updated_at date 更新时间
+ created_at date 创建时间
+ file_id int 主键id

返回示例:

{
    "code": 200,
    "msg": "操作成功",
    "result": {
        "file_id": 4,
        "created_at": "2020-11-11 14:31:00",
        "updated_at": "2020-11-11 15:46:34",
        "url": "http://apir.fidis.com/storage/indass\\2020\\11\\11/iSJdES2kUsaUh5k29L3ZvyPMxad7qVo9agmuBIcc.pdf",
        "nick_name": "测试",
        "system": "indass",
        "full_name": "IMC第三方应用集成手册20201029.pdf",
        "file_type": "pdf",
        "file_path": "indass\\2020\\11\\11/iSJdES2kUsaUh5k29L3ZvyPMxad7qVo9agmuBIcc.pdf"
    }
}

1.5.3. 下载接口

请求地址:

属性
URL api/v1/file/download
Method get
Content-Type multipart/form-data

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
file_id int 非空整形 1 apir_file_record的主键id

响应参数:

参数名称 数据类型 描述
具体的文件 file -
© Mixlinker all right reserved,powered by Gitbook文件修订时间: 2021-03-05 16:09:24

results matching ""

    No results matching ""