axios 请求的配置选项

这些是创建请求时可以用的配置选项。只有url是必须的,如果没有指定method,请求将默认使用get方法。
axiosaxios 最全 请求拦截器 响应拦截器 配置公共请求头 超时时间 以及get delete post put 四种请求传参方式可以参考这篇文章

{
    
         
	// url 是用于请求的服务器 URL  
    url: '/user', 
    
    // method 是创建请求时使用的方法   
    method: 'get',    // default   
    
    // baseURL 将自动加在 url 前面,除非 url 是一个绝对 URL    
    // 它可以通过设置一个 baseURL 便于为 axios 实例的方法传递相对 URL   
    baseURL: 'https://some-domain.com/api/',    
    
   // transformRequest 允许在向服务器发送前,修改请求数据  
   // 只能用在 PUT、POST 和 PATCH 这几个请求方法  
   // 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream   
    transformRequest: [function (data, headers) {
    
         
        // 对 data 进行任意转换处理     
        return data;  
      }],    
      
   // transformResponse 在传递给 then/catch 前,允许修改响应数据  
   transformResponse: [function (data) {
    
           
        // 对 data 进行任意转换处理       
        return data;    
       }],   
       
   // headers 是即将被发送的自定义请求头   
    headers: {
    
    'X-Requested-With': 'XMLHttpRequest'},     
     
   // params 是即将与请求一起发送的 URL 参数  
   // 必须是一个无格式对象 (plain object) 或 URLSearchParams 对象    
    params: {
    
            
     ID: 12345   
       },    
   // paramsSerializer 是一个负责 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 是作为请求主体被发送的数据    
   // 只适用于这些请求方法 PUT、POST 和 PATCH    
   // 在没有设置 transformRequest 时,必须是以下类型之一:   
   // - string,plain object,ArrayBuffer,ArrayBufferView,URLSearchParams   
   // - 浏览器专属:FormData,File,Blob    
   // - Node专属:Stream    
    data: {
    
          
       firstName: 'Fred'  
       },    
   // timeout 指定请求超时的毫秒数(0 表示无超时时间)    
   // 如果请求花费了超过 timeout 的时间,请求将被中断    
   timeout: 1000,    
   
   // withCredentials 表示跨域请求时是否需要使用凭证    
   withCredentials: false,    // default         
   // adapter 允许自定义处理请求,以使测试更轻松   
   // 返回一个 promise 并应用一个有效的响应(查阅 [response docs](#response-api))   
   adapter: function (config) {
    
        
            /* ... */   
          },    
          
   // auth 表示应该使用 HTTP 基础验证,并提供凭据    
   // 这将设置一个 Authorization 头,覆写掉现有的任意使用 headers 设置的自定义 Authorization 头     
   auth: {
    
            
    username: 'janedoe',  
    password: 's00pers3cret'   
    },   
    
  // responseType 表示服务器响应的数据类型,可以是 arraybuffer、blob、document、json、text、stream    
  responseType: 'json',    // default    
  // responseEncoding 表示对响应的编码    
  // Note:对于 responseType 为 stream 或 客户端请求会忽略    
  
  responseEncoding: 'utf-8',    
  
  // xsrfCookieName 是用作 xsrf token 值的 cookie 名称     xsrfCookieName: 'XSRF-TOKEN',   
  // default     
  // xsrfHeaderName 是 xsrf token 值的 http 头名称     
  xsrfHeaderName: 'X-XSRF-TOKEN',    // default      
        
  // onUploadProgress 允许为上传处理进度事件     
  onUploadProgress: function (progressEvent) {
    
          
           // ... ...    
       },   
             
  // onDownloadProgress 允许为下载处理进度事件     
      onDownloadProgress: function (progressEvent) {
    
        
             // ... ...  
         },   
          
 // maxContentLength 定义允许的响应内容的最大尺寸     
      maxContentLength: 2000,     
           
 // validateStatus 定义对于给定的 HTTP 响应状态码是 resolve 或 reject promise。   
 // 如果 validateStatus 返回 true (或者设置为 null 或 undefined),promise 将被 resolve,否则 promise 将被 reject   
      validateStatus: function (status) {
    
         
            return status >= 200 && status < 300;    // default  
         },    
         
 // maxRedirects 定义在 node.js 中 follow 的最大重定向数目     
 // 如果设置为 0,将不会 follow 任何重定向    
       maxRedirects: 5,   
         
 // socketPath 用于在 node.js 中定义 UNIX Socket     
 // e.g. '/var/run/docker.sock' to send requests to the docker daemon.    
 // 只能指定 socketPath 或 proxy,如果两者同时指定,将使用 socketPath     
      ocketPath: null,     
      
 // httpAgent 和 httpsAgent 分别在 node.js 中用于定义在执行 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: 'rapunz31'    
           }  
       },     
 // cancelToken 指定用于取消请求的 cancel token    
     cancelToken: new CancelToken(function (cancel) {
    
       
            // ... ...   
      }) }

猜你喜欢

转载自blog.csdn.net/weixin_47988564/article/details/108129720