接口需求文档

本文介绍了两个API接口,/passFile用于文档审核,需要POST请求,包含ID和密码参数以验证权限。/downLoad接口则用于文件下载,支持GET请求,参数包括FileId、下载类型及是否压缩选项。
摘要由CSDN通过智能技术生成

写两个接口用于审核文档和下载文档

接口1:/passFile

功能说明:审核通过文档

  1. 请求地址:https://host/user/passFile

  2. 请求头:

    请求头 请求内容说明
    Authorization Basic_Id访问token
    Content-Type application/json请求方式
  3. 请求方式:POST

  4. 参数类型:JSON

  5. 请求示例:

    [
        
            {"id":"2022405506",
            "password":"666666"
            }
        
    ]
  6. 请求参数说明

    字段名 字段说明 字段类型是否必填
    id 登录id int
    password 登录密码 vachar

  7. 响应示例

    成功响应编码

    {
        "code: "200",
        "message":"请求成功",
        "data":返回数据
        
    }
  8. 响应参数说明

    接口返回码接口返回描述
    200成功
    400请求异常
    401授权失败
    500系统异常
  9. 分析:

    请求头中的authorization是在HTTP请求中携带的身份验证信息,用于验证请求的合法性和权限,其头部的值由用户名id和密码password组成的字符串。通过对其头部的值进行解码和验证,以确定用户请求是否合法和有权限执行

接口2:/downLoad

功能说明:下载文件

  1. 请求地址:https://host/user/downLoad

  2. 请求参数说明

    名称 类型 是否必须描述
    FileId Long IDID
    downloadItems String[] 否下载可选项,NOMAL(中文),ATTACHMENT(附件)
    needCompressForOneFile Boolean 是,默认单文件也压缩当下载的文件仅一份时,是否压缩

  3. 请求方式:GET

  4. 参数类型:JSON

  5. 请求示例

    {
        "url":"https://host/user/downLoad",
        "method":"GET",
        "headers":{},
        "params":{
            "FileId":2022405506,
            "downloadItems ":["NORMAL"],
            "needCompressForOneFile ":f
        }
    }

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值