Axios 請求配置引數詳解以及全域性配置示例
基本應用:
// 傳送 POST 請求
axios({
method: 'post',
url: '/user/12345',
data: {
firstName: 'Fred',
lastName: 'Flintstone'
}
});
請求配置
{
// `url` 是用於請求的伺服器 URL
url: '/user',
// `method` 是建立請求時使用的方法
method: 'get', // 預設是 get
// `baseURL` 將自動加在 `url` 前面,除非 `url` 是一個絕對 URL。
// 它可以通過設定一個 `baseURL` 便於為 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 引數
// 必須是一個無格式物件(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, // 預設的
// `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', // 預設的
// `xsrfCookieName` 是用作 xsrf token 的值的cookie的名稱
xsrfCookieName: 'XSRF-TOKEN', // default
// `xsrfHeaderName` 是承載 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; 否則,promise 將被 rejecte
validateStatus: function (status) {
return status >= 200 && status < 300; // 預設的
},
// `maxRedirects` 定義在 node.js 中 follow 的最大重定向數目
// 如果設定為0,將不會 follow 任何重定向
maxRedirects: 5, // 預設的
// `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: 'rapunz3l'
}
},
// `cancelToken` 指定用於取消請求的 cancel token
// (檢視後面的 Cancellation 這節瞭解更多)
cancelToken: new CancelToken(function (cancel) {
})
}
返回Promise時使用then時,你將接收下面這樣的響應:
axios.get('/user/12345')
.then(function(response) {
console.log(response.data);
console.log(response.status);
console.log(response.statusText);
console.log(response.headers);
console.log(response.config);
});
配置的預設值/defaults
axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
全域性配置示例/請求攔截
axios.interceptors.request.use(function (config) {
config.withCredentials = true
config.headers = {
"TOKEN":"************"
}
return config;
}, function (error) {
return Promise.reject(error);
})
相關文章
- pytest + yaml 框架 -68.新增全域性請求引數配置verify和headersYAML框架Header
- SwaggerAPI註解詳解,以及註解常用引數配置SwaggerAPI
- apache伺服器全域性配置詳解(全)Apache伺服器
- Prometheus hashmod 配置引數詳解Prometheus
- 基礎設施建設——全域性請求引數校驗
- Nginx 配置檔案引數詳解Nginx
- ansible.cfg 配置引數詳解
- 輕鬆搞定Retrofit不同網路請求方式的請求引數配置,及常用註解使用
- SpringBoot使用Axios傳送請求,引數處理Spring BootiOS
- 輕鬆搞定Retrofit不同網路請求方式的請求引數配置,Retrofit常用註解的使用
- consul配置引數大全、詳解、總結
- mac配置全域性環境變數Mac變數
- axios模擬GET請求例項及詳解iOS
- nginx 常見引數以及重定向引數配置Nginx
- MongoDB啟動檔案配置引數詳解MongoDB
- redis配置檔案中各引數詳解Redis
- Linux網路卡配置檔案 引數詳解Linux
- MySQL8.0新增配置引數詳解MySql
- 配置路由的預設class + 將axios設定全域性註冊路由iOS
- vue-cli 配置 sass 全域性變數Vue變數
- axios 請求iOS
- 線上直播系統原始碼,Vue3中全域性配置 axios原始碼VueiOS
- curl常用引數詳解及示例
- maven-compiler-plugin外掛引數配置詳解MavenCompilePlugin
- 監聽配置細節引數詳解兩則
- 封裝axios請求並對提交引數進行校驗封裝iOS
- jQuery Validate全域性配置和例項配置jQuery
- axios get請求如果遇到引數有陣列的情況怎麼解決iOS陣列
- laravel 傳送郵件以及引數配置Laravel
- Vue中使用CSS前處理器 stylus以及配置全域性變數的方法VueCSS變數
- 寫給美術看的Unity全域性光照詳解(引數篇)Unity
- 有趣的請求引數/請求頭
- axios請求超時解決方案iOS
- 引數配置
- drf : 請求(Request)與響應(Response),全域性設定和區域性設定drf的預設配置項。
- 常用的jvm配置引數 :永久區引數配置JVM
- Springboot請求引數解密Spring Boot解密
- SpringMVC請求引數解析SpringMVC