Axios 中文说明


使用说明  

##Axios

npm version
build status
code coverage
npm downloads
gitter chat

Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。

XMLHttpRequests
  • 从 node.js 创建 http 请求
  • 支持 Promise API
  • 拦截请求和响应
  • 转换请求数据和响应数据
  • 取消请求
  • 自动转换 JSON 数据
  • 客户端支持防御 XSRF
  • 安装

    使用 npm:

    $ npm install axios

    使用 bower:

    $ bower install axios
    

    使用 cdn:

    Example

    执行 GET 请求

    // 为给定 ID 的 user 创建请求
    axios.get('/user?ID=12345')
      .then(function (response) {
        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: 'Fred',
        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([getUserAccount(), getUserPermissions()])
      .then(axios.spread(function (acct, perms) {
        // 两个请求现在都执行完成
      }));

    rejection callback 作为 then 的第二个参数时,响应可以通过 error 对象可被使用,正如在错误处理这一节所讲。

    cancelable promises proposal,它还处于第一阶段。

    可以使用 CancelToken.source 工厂方法创建 cancel token,像这样:

    var CancelToken = axios.CancelToken;
    var source = CancelToken.source();
    
    axios.get('/user/12345', {
      cancelToken: source.token
    }).catch(function(thrown) {
      if (axios.isCancel(thrown)) {
        console.log('Request canceled', thrown.message);
      } else {
        // 处理错误
      }
    });
    
    // 取消请求(message 参数是可选的)
    source.cancel('Operation canceled by the user.');

    还可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token:

    var CancelToken = axios.CancelToken;
    var cancel;
    
    axios.get('/user/12345', {
      cancelToken: new CancelToken(function executor(c) {
        // executor 函数接收一个 cancel 函数作为参数
        cancel = c;
      })
    });
    
    // 取消请求
    cancel();

    Note : 可以使用同一个 cancel token 取消多个请求

    被支持.
    如果你的环境不支持 ES6 Promise,你可以使用 polyfill.

    TypeScript definitions.

    import axios from 'axios';
    axios.get('/user?ID=12345');

    Changelog
  • Upgrade Guide
  • Ecosystem
  • Contributing Guide
  • Code of Conduct
  • $http service provided in Angular. Ultimately axios is an effort to provide a standalone $http-like service for use outside of Angular.

    升级指南  

    vue