知识森林

Appearance

On this page

http 使用说明 ​

首先确保在 http配置 中正确配置信息。

get | post | put | delete 请求 ​

支持三个参数：

ts
// demo
http.post('/**/test', {
    name: '张三',
    age: 18
}, {
    onlyData: false
}).then( rsp => {
    // 打印结果
    log(rsp)
} )

uploadFile 文件上传 ​

支持两个参数：

  • 配置项： AxiosRequestConfig（axios）
  • 请求参数: Object
ts
// demo
http
    .uploadFile({ 
        url: 'test',
        onUploadProgress(data) {
            log(`当前上传进度${data.loaded / data.total * 100}%`)
        }
    }, { file: 'xxxxx', filename: 'xxx' })
    .then( rsp => {
        log('文件上传成功')
    } )

exportFile 文件下载 ​

支持三个参数：

  • 请求url： string | ApiType
  • 请求参数: Object
  • fileName: 文件名
ts
// demo
http.exportFile('test', { file: 'xxxxx', filename: 'xxx' }, '测试文件')

RequestOptions ​

属性说明类型默认值版本
joinParamsToUrl是否将参数拼接在url后面boolean
formatDate时间是否需要转为时间戳boolean
joinTime请求时候是否加上时间戳boolean
ignoreRepeatRequest是否忽略重复请求boolean
withToken请求时是否需要tokenboolean
onlyData是否只返回databoolean
contentType请求类型HttpContentTypeEnum
headers请求头Partial<AxiosRequestHeaders>
responseType返回类型'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream'
ts
// http请求类型
export enum HttpContentTypeEnum {
    // json
    JSON = 'application/json;charset=UTF-8',
    // form-data qs
    FORM_URLENCODED = 'application/x-www-form-urlencoded;charset=UTF-8',
    // form-data  upload
    FORM_DATA = 'multipart/form-data;charset=UTF-8',
}