在用Vue做开发的时候,官方推荐的前后端通信插件是axios,Github上axios的文档虽然详细,但是却是英文版.现在发现有个axios的中文文档,于是就转载过来了!
原文地址 : https://github.com/mzabriskie/axios
简介
版本:v0.16.1
基于http客户端的promise，面向浏览器和nodejs
特色
浏览器端发起XMLHttpRequests请求
node端发起http请求
支持Promise API
拦截请求和返回
转化请求和返回（数据）
取消请求
自动转化json数据
客户端支持抵御XSRF（跨站请求伪造）
安装
使用npm：
$ npm i axios
使用 bower
$ bower instal axios
使用cdn
<!--国内bootCDN--> <script src="https://cdn.bootcss.com/axios/0.16.0/axios.min.js"></script>
示例
发起一个GET请求
//发起一个user请求，参数为给定的ID axios.get('/user?ID=1234') .then(function(respone){ console.log(response); }) .catch(function(error){ console.log(error); }); //上面的请求也可选择下面的方式来写 axios.get('/user',{ params:{ ID:12345 } }) .then(function(response){ console.log(response); }) .catch(function(error){ console.log(error) });
发起一个POST请求
axios.post('/user',{ firstName:'friend', lastName:'Flintstone' }) .then(function(response){ console.log(response); }) .catch(function(error){ console.log(error); });
发起一个多重并发请求
function getUserAccount(){ return axios.get('/user/12345'); } function getUserPermissions(){ return axios.get('/user/12345/permissions'); } axios.all([getUerAccount(),getUserPermissions()]) .then(axios.spread(function(acc,pers){ //两个请求现在都完成 }));
axios API
可以对axios进行一些设置来生成请求。
axios(config)
//发起 POST请求 axios({ method:'post',//方法 url:'/user/12345',//地址 data:{//参数 firstName:'Fred', lastName:'Flintstone' } });
//通过请求获取远程图片 axios({ method:'get', url:'http://bit.ly/2mTM3Ny', responseType:'stream' }) .then(function(response){ response.data.pipe(fs.createWriteStream('ada_lovelace.jpg')) })
axios(url[,config])
//发起一个GET请求 axios('/user/12345/);
请求方法的重命名。
为了方便，axios提供了所有请求方法的重命名支持
axios.request(config)
axios.get(url[,config])
axios.delete(url[,config])
axios.head(url[,config])
axios.options(url[,config])
axios.post(url[,data[,config]])
axios.put(url[,data[,config]])
axios.patch(url[,data[,config]])
注意
当时用重命名方法时url,method,以及data属性不需要在config中指定。
并发 Concurrency
有用的方法
axios.all(iterable)
axios.spread(callback)
创建一个实例
你可以使用自定义设置创建一个新的实例
axios.create([config])
var instance = axios.create({ baseURL:'http://some-domain.com/api/', timeout:1000, headers:{'X-Custom-Header':'foobar'} });
实例方法
下面列出了一些实例方法。具体的设置将在实例设置中被合并。
axios#request(config)
axios#get(url[,config])
axios#delete(url[,config])
axios#head(url[,config])
axios#post(url[,data[,config]])
axios#put(url[,data[,config]])
axios#patch(url[,data[,config]])
Requese Config请求设置
以下列出了一些请求时的设置选项。只有url是必须的，如果没有指明method的话，默认的请求方法是GET.
{ //`url`是服务器链接，用来请求 url:'/user', //`method`是发起请求时的请求方法 method:`get`, //`baseURL`如果`url`不是绝对地址，那么将会加在其前面。 //当axios使用相对地址时这个设置非常方便 //在其实例中的方法 baseURL:'http://some-domain.com/api/', //`transformRequest`允许请求的数据在传到服务器之前进行转化。 //这个只适用于`PUT`,`GET`,`PATCH`方法。 //数组中的最后一个函数必须返回一个字符串或者一个`ArrayBuffer`,或者`Stream`,`Buffer`实例,`ArrayBuffer`,`FormData` transformRequest:[function(data){ //依自己的需求对请求数据进行处理 return data; }], //`transformResponse`允许返回的数据传入then/catch之前进行处理 transformResponse:[function(data){ //依需要对数据进行处理 return data; }], //`headers`是自定义的要被发送的头信息 headers:{'X-Requested-with':'XMLHttpRequest'}, //`params`是请求连接中的请求参数，必须是一个纯对象，或者URLSearchParams对象 params:{ ID:12345 }, //`paramsSerializer`是一个可选的函数，是用来序列化参数 //例如：（https://ww.npmjs.com/package/qs,) 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`定义请求的时间，单位是毫秒。 //如果请求的时间超过这个设定时间，请求将会停止。 timeout:1000, //`withCredentials`表明是否跨网站访问协议， //应该使用证书 withCredentials:false //默认值 //`adapter`适配器，允许自定义处理请求，这会使测试更简单。 //返回一个promise，并且提供验证返回（查看[response docs](#response-api)） adapter:function(config){ /*...*/ }, //`auth`表明HTTP基础的认证应该被使用，并且提供证书。 //这个会设置一个`authorization` 头（header），并且覆盖你在header设置的Authorization头信息。 auth:{ username:'janedoe', password:'s00pers3cret' }, //`responsetype`表明服务器返回的数据类型，这些类型的设置应该是 //'arraybuffer','blob','document','json','text',stream' responsetype:'json', //`xsrfHeaderName` 是http头（header）的名字，并且该头携带xsrf的值 xrsfHeadername:'X-XSRF-TOKEN'，//默认值 //`onUploadProgress`允许处理上传过程的事件 onUploadProgress: function(progressEvent){ //本地过程事件发生时想做的事 }, //`onDownloadProgress`允许处理下载过程的事件 onDownloadProgress: function(progressEvent){ //下载过程中想做的事 }, //`maxContentLength` 定义http返回内容的最大容量 maxContentLength: 2000, //`validateStatus` 定义promise的resolve和reject。 //http返回状态码，如果`validateStatus`返回true（或者设置成null/undefined），promise将会接受；其他的promise将会拒绝。 validateStatus: function(status){ return status >= 200 && stauts < 300;//默认 }, //`httpAgent` 和 `httpsAgent`当产生一个http或者https请求时分别定义一个自定义的代理，在nodejs中。 //这个允许设置一些选选个，像是`keepAlive`--这个在默认中是没有开启的。 httpAgent: new http.Agent({keepAlive:treu}), httpsAgent: new https.Agent({keepAlive:true}), //`proxy`定义服务器的主机名字和端口号。 //`auth`表明HTTP基本认证应该跟`proxy`相连接，并且提供证书。 //这个将设置一个'Proxy-Authorization'头(header)，覆盖原先自定义的。 proxy:{ host:127.0.0.1, port:9000, auth:{ username:'cdd', password:'123456' } }, //`cancelTaken` 定义一个取消，能够用来取消请求 //（查看 下面的Cancellation 的详细部分） cancelToken: new CancelToken(function(cancel){ }) }
返回响应概要 Response Schema
一个请求的返回包含以下信息