url: ‘/user’
url是将用于发送请求
method: ‘get’, 默认值 get
设置请求类型,get/post
baseURL: ‘https://some-domain.com/api/’
基本地址 ,发送请求的地址=baseURL+url
transformRequest: [function (data, headers) {return data;}]
transformRequest`允许在将请求数据发送到服务器之前对其进 行更改
仅适用于请求方法'PUT','POST','PATCH'和'DELETE'
数组中的最后一个函数必须返回字符串或Buffer, ArrayBuffer,FormData或Stream 的实例//您可以修改标头对象
transformResponse: [function (data) return data; }]
transformResponse允许更改响应数据,然后将其传递给then / catch
headers: {‘X-Requested-With’: ‘XMLHttpRequest’}
设置请求头信息
params: {ID: 12345},
params是要与请求一起发送的URL参数
必须是普通对象或URLSearchParams对象
paramsSerializer: function (params) { return Qs.stringify(params, {arrayFormat: ‘brackets’}) }
对请求的参数做一个序列化,转换成一个字符串,并返回
data: {firstName: ‘Fred’}
data是要作为请求正文发送的数据
仅适用于请求方法'PUT','POST','DELETE和'PATCH'
data: ‘Country=Brasil&City=Belo Horizonte’
将数据发送到正文中的语法替代
timeout: 1000, 默认值 0
(no timeout)
timeout指定请求超时之前的毫秒数。
如果请求所花的时间超过`timeout`,则该请求将被中 止。
withCredentials: false, 默认值 false
withCredentials指示是否应使用凭证
adapter: function (config) { /* … */}
adapter允许自定义处理请求,这使得测试更加容易。
返回承诺并提供有效的响应
auth: {username: ‘janedoe’,password: ‘s00pers3cret’}
验证用户名和密码的
responseType: ‘json’, // 默认值
responseType 表示数据与服务器将响应类型
选项有:'arraybuffer', 'document', 'json', 'text', 'stream'
responseEncoding: ‘utf8’,默认值 utf8
responseEncoding 表示用于解码响应的编码(仅适用于 Node.js)
安全:
1.xsrfCookieName: ‘XSRF-TOKEN’, -默认值
xsrfCookieName是cookie的名称,用作xsrf令牌的值
2.xsrfHeaderName: ‘X-XSRF-TOKEN’, -默认值
xsrfHeaderName是带有xsrf令牌值
onUploadProgress: function (progressEvent) {
onUploadProgress允许处理上载的进度事件
仅浏览器
onDownloadProgress: function (progressEvent) { }
onDownloadProgress允许处理下载的进度事件
仅浏览器
maxContentLength: 2000,
响应体的最大内容以node.js中允许的字节数
maxBodyLength: 2000,
请求体的最大内容,定义http请求内容的最大大小(以字节为单位)
validateStatus: function (status) { return status >= 200 && status < 300; // default}
什么情况下认为他是成功的,可以设置成功的条件
maxRedirects: 5, -默认值
最大的跳转次数,只能用于node.js
socketPath: null,-默认值
做数据转发
例如'/var/run/docker.sock'将请求发送到docker守护进程。
只能指定`socketPath`或`proxy`。
如果两者都指定,则使用`socketPath`。
httpAgent: new http.Agent({ keepAlive: true })
httpsAgent: new https.Agent({ keepAlive: true })
对http信息做一些设置,上面的设置是保持连接
proxy
proxy: {
protocol: 'https',
host: '127.0.0.1',
port: 9000,
auth: {
username: 'mikeymike',
password: 'rapunz3l'
}},
proxy定义代理服务器的主机名,端口和协议。
cancelToken: new CancelToken(function (cancel) {})
cancelToken指定可用于取消请求的取消令牌
decompress: true -默认值
//`decompress`指示是否应自动 只能再node.js设置