axios 请求参数配置说明

Posted 2021-01-19 web前端开发技术

axios的配置项地址参考： https://www.npmjs.com/package/axios

{
  // `url` is the server URL that will be used for the request
  url: ‘/user‘,
 
  // `method` is the request method to be used when making the request
  method: ‘get‘, // default
 
  // `baseURL` will be prepended to `url` unless `url` is absolute.
  // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
  // to methods of that instance.
  baseURL: ‘https://some-domain.com/api/‘,
 
  // `transformRequest` allows changes to the request data before it is sent to the server
  // This is only applicable for request methods ‘PUT‘, ‘POST‘, and ‘PATCH‘
  // The last function in the array must return a string or an instance of Buffer, ArrayBuffer,
  // FormData or Stream
  // You may modify the headers object.
  transformRequest: [function (data, headers) {
    // Do whatever you want to transform the data
 
    return data;
  }],
 
  // `transformResponse` allows changes to the response data to be made before
  // it is passed to then/catch
  transformResponse: [function (data) {
    // Do whatever you want to transform the data
 
    return data;
  }],
 
  // `headers` are custom headers to be sent
  headers: {‘X-Requested-With‘: ‘XMLHttpRequest‘},
 
  // `params` are the URL parameters to be sent with the request
  // Must be a plain object or a URLSearchParams object
  params: {
    ID: 12345
  },
 
  // `paramsSerializer` is an optional function in charge of serializing `params`
  // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  paramsSerializer: function(params) {
    return Qs.stringify(params, {arrayFormat: ‘brackets‘})
  },
 
  // `data` is the data to be sent as the request body
  // Only applicable for request methods ‘PUT‘, ‘POST‘, and ‘PATCH‘
  // When no `transformRequest` is set, must be of one of the following types:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - Browser only: FormData, File, Blob
  // - Node only: Stream, Buffer
  data: {
    firstName: ‘Fred‘
  },
 
  // `timeout` specifies the number of milliseconds before the request times out.
  // If the request takes longer than `timeout`, the request will be aborted.
  timeout: 1000,
 
  // `withCredentials` indicates whether or not cross-site Access-Control requests
  // should be made using credentials
  withCredentials: false, // default
 
  // `adapter` allows custom handling of requests which makes testing easier.
  // Return a promise and supply a valid response (see lib/adapters/README.md).
  adapter: function (config) {
    /* ... */
  },
 
  // `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
  // This will set an `Authorization` header, overwriting any existing
  // `Authorization` custom headers you have set using `headers`.
  auth: {
    username: ‘janedoe‘,
    password: ‘s00pers3cret‘
  },
 
  // `responseType` indicates the type of data that the server will respond with
  // options are ‘arraybuffer‘, ‘blob‘, ‘document‘, ‘json‘, ‘text‘, ‘stream‘
  responseType: ‘json‘, // default
 
  // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token
  xsrfCookieName: ‘XSRF-TOKEN‘, // default
 
  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  xsrfHeaderName: ‘X-XSRF-TOKEN‘, // default
 
  // `onUploadProgress` allows handling of progress events for uploads
  onUploadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },
 
  // `onDownloadProgress` allows handling of progress events for downloads
  onDownloadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },
 
  // `maxContentLength` defines the max size of the http response content allowed
  maxContentLength: 2000,
 
  // `validateStatus` defines whether to resolve or reject the promise for a given
  // HTTP response status code. If `validateStatus` returns `true` (or is set to `null`
  // or `undefined`), the promise will be resolved; otherwise, the promise will be
  // rejected.
  validateStatus: function (status) {
    return status >= 200 && status < 300; // default
  },
 
  // `maxRedirects` defines the maximum number of redirects to follow in node.js.
  // If set to 0, no redirects will be followed.
  maxRedirects: 5, // default
 
  // `socketPath` defines a UNIX Socket to be used in node.js.
  // e.g. ‘/var/run/docker.sock‘ to send requests to the docker daemon.
  // Only either `socketPath` or `proxy` can be specified.
  // If both are specified, `socketPath` is used.
  socketPath: null, // default
 
  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows options to be added like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),
 
  // ‘proxy‘ defines the hostname and port of the proxy server
  // Use `false` to disable proxies, ignoring environment variables.
  // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and
  // supplies credentials.
  // This will set an `Proxy-Authorization` header, overwriting any existing
  // `Proxy-Authorization` custom headers you have set using `headers`.
  proxy: {
    host: ‘127.0.0.1‘,
    port: 9000,
    auth: {
      username: ‘mikeymike‘,
      password: ‘rapunz3l‘
    }
  },
 
  // `cancelToken` specifies a cancel token that can be used to cancel the request
  // (see Cancellation section below for details)
  cancelToken: new CancelToken(function (cancel) {
  })
}

 

1、url（必写）

请求地址

2、method

请求方法，默认是get

3、baseURL（常用）

baseURL会添加到url前（url是绝对地址除外）。

4、transformRequest

`transformRequest`选项允许我们在请求发送到服务器之前对请求的数据做出一些改动
该选项只适用于以下请求方式：`put/post/patch`
5、transformResponse
`transformResponse`选项允许我们在数据传送到`then/catch`方法之前对数据进行改动
6、headers（常用，如设置请求头json类型）
自定义请求头信息
7、params（常用，只有get请求设置params，其他请求需设置params,即只有get的请求参数位于url后，其他请求参数都在请求体中）
`params`选项是要随请求一起发送的请求参数----一般链接在URL后面
8、data（常用）
`data`选项是作为一个请求体而需要被发送的数据，该选项只适用于方法：`put/post/patch`
在浏览器上data只能是FormData, File, Blob格式
9、timeout（常用）
超时时间
10、withCredentials
`withCredentails`选项表明了是否是跨域请求、默认是default
11、onUploadProgress
`onUploadProgress`上传进度事件
12、onDownloadProgress
下载进度的事件
13、maxContentLength
相应内容的最大值