1.1.0 • Published 2 years ago

@zebra-ui/uniapp-axios v1.1.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

zebra-ui-uniapp-axios

NPM version npm download

axios adapter for uni-app.

安装

$ npm install --save @zebra-ui/uniapp-axios axios

使用

// request.js
import axios from 'axios'
import uniAdapter from '@zebra-ui/uniapp-axios'

// create an axios instance
const service = axios.create({
  adapter: uniAdapter,
  baseURL: 'http://127.0.0.1:8080', // url = base url + request url
  // withCredentials: true, // send cookies when cross-domain requests
  timeout: 5000 // request timeout
})

export default service

发起请求

// api.js
import request from "./utils/request";

export function postData(data) {
  return request({
    url: '/your/api/url',
    method: 'POST',
    data
  })
}

与axios使用无差别。

差异

配置config

默认使用uni.request发起请求,但在特定条件下会自动变换成uni.uploadFileuni.downloadFile

参数类型默认值说明
adapterFunctionuniAdapter自定义适配器
baseURLString基础地址
urlString请求地址
methodStringget请求方法
paramsObject请求参数
dataString/Object/ArrayBuffer请求数据
headersObject请求头,当Header中Content-Type赋值为multipart/form-data时会自动使用uni.uploadFile
paramsSerializerFunction在Get请求时会自动将params赋值给uni-app的data
cancelTokenObject取消令牌
timeoutNumber5000超时时间
responseTypeStringJson会直接将该值自动赋值给uni中的dataType,但同时赋值给uni中的responseType,非arraybuffer时全都转为text
sslVerifyBooleantrue增加字段,等同uni-app配置
withCredentialsBooleanfalse增加字段,等同uni-app配置
firstIpv4Booleanfalse增加字段,等同uni-app配置
onDownloadProgressFunction当该值赋值时且method为get时会自动使用uni.downloadFile
onUploadProgressFunction在使用uni.uploadFIle时生效