一,前言
本篇介绍创建请求时可以用的配置选项,多数例子来自文档
二,请求配置
创建请求时可用配置选项中,只有url是必需的
若没指定method,默认使用get方法
{
// url:请求的服务器URL
url: '/user',
// method:请求使用的方法,默认get
method: 'get',
// baseURL:自动在url前添加(绝对URL除外),便于为 axios 实例的方法传递相对 URL
baseURL: 'https://some-domain.com/api/',
// transformRequest:向服务器发送前修改请求数据,仅用于PUT,POST,PATCH请求方法
// 数组中的函数必须返回一个字符串或ArrayBuffer或Stream
transformRequest: [function (data) {
// 对 data 进行任意转换处理
return data;
}],
// transformResponse:传递给then/catch前,允许修改响应数据
transformResponse: [function (data) {
// 对 data 进行任意转换处理
return data;
}],
// headers:自定义请求头
headers: {'X-Requested-With': 'XMLHttpRequest'},
// params:URL参数
params: {
ID: 12345
},
// paramsSerializer:负责params序列化的函数
paramsSerializer: function(params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
},
// data:被发送的数据,只适用于PUT,POST,PATCH
// 没设置 transformRequest时,必须是以下类型之一:
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
// - 浏览器专属:FormData, File, Blob
// - Node 专属: Stream
data: {
firstName: 'Fred'
},
// timeout:请求超时的毫秒数(0 表示无超时时间),超过将被中断
timeout: 1000,
// withCredentials:跨域请求是否使用凭证,默认false不需要
withCredentials: false,
// adapter:允许自定义处理请求,以使测试更轻松
// 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// auth:使用HTTP基础验证并提供凭据
// 这将设置一个Authorization头,覆写现有的任意使用headers设置的自定义Authorization头
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
// responseType:服务器响应的数据类型,默认json
// 可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
responseType: 'json',
// xsrfCookieName:用作xsrf token值的cookie名称
xsrfCookieName: 'XSRF-TOKEN', // default
// xsrfHeaderNameL承载xsrf token值的HTTP头名称
xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的
// onUploadProgress:允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// onDownloadProgress:允许为下载处理进度事件
onDownloadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// maxContentLength:响应内容最大尺寸
maxContentLength: 2000,
// validateStatus:定义HTTP状态码是resolve或reject promise
// 若validateStatus返回true(或null或undefined),promise将被resolve,否则被rejecte
validateStatus: function (status) {
return status >= 200 && status < 300; // 默认的-200系列
},
// maxRedirects:最大重定向数目,设置为0,将不会follow任何重定向
maxRedirects: 5, // 默认的
// httpAgent和httpsAgent分别为执行http和https时的自定义代理。
// keepAlive默认不启用
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
// proxy:代理服务器的主机名称和端口
// auth表示HTTP基础验证应当用于连接代理,并提供凭据
// 这将会设置一个Proxy-Authorization头,覆写已有的通过header设置的自定义Proxy-Authorization头
proxy: {
host: '127.0.0.1',
port: 9000,
auth: : {
username: 'mikeymike',
password: 'rapunz3l'
}
},
// cancelToken:指定取消请求的cancel token
cancelToken: new CancelToken(function (cancel) {
})
}
三,结尾
本篇介绍创建请求时可以用的配置选项,多数例子来自文档