vue項目接口管理,所有接口都在apis文件夾中統(tǒng)一管理操作
在vue開發(fā)中,會涉及到很多接口的處理,當(dāng)項目足夠大時,就需要定義規(guī)范統(tǒng)一的接口,如何定義呢?
方法可能不只一種,本文使用axios+async/await進(jìn)行接口的統(tǒng)一管理
本文使用vue-cli生成的項目舉例
使用接口管理之前
在項目的某個具體組件中調(diào)接口,把調(diào)用接口的方法直接寫在mounted中,或在是methods中 比如:
xxx.vue
<template> <div id="areaTree"> <!-- 標(biāo)題 --> <div class="leftTree_Title"> <el-row> <el-col :span="24">{{msg}}</el-col> </el-row> </div> </div> </template> <script> import axios from 'axios' export default { name: "test", data:function(){ return{ msg:'站點選擇', } }, methods:{ }, computed:{ }, //--------------Vue生命周期---具體細(xì)節(jié)參考:https://www.cnblogs.com/yingyigongzi/p/10844175.html --------------- beforeCreate(){ }, created(){ }, beforeMount(){ }, mounted(){ //理解成初始化,該操作只會執(zhí)行一次 axios.get('/GetTreeListForSoilByRegion',{ //從接口讀取數(shù)據(jù) params: { //參數(shù) } }) .then(function (response) { //代碼操作 }) .catch(function (error) { console.log(error); }); }, beforeUpdate(){ }, updated(){ }, beforeDestroy(){ }, destroyed(){ }, //--------------Vue生命周期---具體細(xì)節(jié)參考:https://www.cnblogs.com/yingyigongzi/p/10844175.html --------------- } </script> <style scoped></style>
使用項目管理之后,可以做到接口一次定義,到處使用,
代碼看起來規(guī)范,所有的接口都在一個文件夾定義,不用分散的各個組件,維護(hù)起來簡單,例如后臺的一些url變了,改起來也方便
步驟:
1.首先,在src目錄下新建一個文件夾,我這里叫apis,后臺提供的所有接口都在這里定義
2.在apis下新建一個js文件,叫http.js,在里面做axios相應(yīng)的配置,目的 封裝axios,完整代碼如下,可以直接使用
http.js
import axios from 'axios' //創(chuàng)建axios的一個實例 var instance = axios.create({ baseURL:'', timeout: 6000 }) //------------------- 一、請求攔截器 忽略 instance.interceptors.request.use(function (config) { return config; }, function (error) { // 對請求錯誤做些什么 return Promise.reject(error); }); //----------------- 二、響應(yīng)攔截器 忽略 instance.interceptors.response.use(function (response) { return response.data; }, function (error) { // 對響應(yīng)錯誤做點什么 console.log('攔截器報錯'); return Promise.reject(error); }); /** * 使用es6的export default導(dǎo)出了一個函數(shù),導(dǎo)出的函數(shù)代替axios去幫我們請求數(shù)據(jù), * 函數(shù)的參數(shù)及返回值如下: * @param {String} method 請求的方法:get、post、delete、put * @param {String} url 請求的url: * @param {Object} data 請求的參數(shù) * @returns {Promise} 返回一個promise對象,其實就相當(dāng)于axios請求數(shù)據(jù)的返回值 */ export default function (method, url, data = null) { method = method.toLowerCase(); if (method == 'post') { return instance.post(url, data) } else if (method == 'get') { return instance.get(url, { params: data }) } else if (method == 'delete') { return instance.delete(url, { params: data }) }else if(method == 'put'){ return instance.put(url,data) }else{ console.error('未知的method'+method) return false } }
3.按照后臺文檔劃分的模塊新建js文件,這里簡單舉個例子
我要去拿樹結(jié)構(gòu)的數(shù)據(jù),到時候處理完數(shù)據(jù)在頁面上顯示出來,操作如下:
a.新建一個navigationTree.js,這里專門用來管理 我的樹組件(即上文的xxx.vue)的接口,(如果還有別的組件,比如aa.vue也要用到接口,可以在api文件夾內(nèi)再創(chuàng)一個aa.js,管理aa.vue的接口)
navigationTree.js
//navigationTree.js 用于獲取導(dǎo)航樹的樹形json數(shù)據(jù) import req from './http.js' //引入封裝好的axios //在這里定義了一個登陸的接口,把登陸的接口暴露出去給組件使用 export const GETTREEDATA =params=>req('get','/GetTreeListForSoilByRegion',params) //這里使用了箭頭函數(shù),轉(zhuǎn)換一下寫法: //export const GETTREEDATA=function(req){ // return req('post','/GetTreeListForSoilByRegion',params) //}
4.在組件中使用接口,來看看現(xiàn)在的xxx.vue
<template> <div id="areaTree"><br> <!-- 標(biāo)題 --><br> <div class="leftTree_Title"><br> <el-row> <br> <el-col :span="24">{{msg}}</el-col> <br> </el-row> <br> </div> <br> </div> </template> <script> //1. 引入獲取樹結(jié)構(gòu)的接口定義 import {GETTREEDATA} from '../apis/navigationTree.js' let treeTemp =[]; export default { name: "zTree", data:function(){ return{ msg:'站點選擇', } }, methods:{ }, computed:{ }, beforeCreate(){ }, created(){ }, beforeMount(){ }, mounted(){ //理解成初始化,該操作只會執(zhí)行一次 let testdata = GETTREEDATA(); //vue項目接口管理,所有接口都在apis文件夾中統(tǒng)一管理 testdata .then(function(response){ //console.log(response); }).catch(function(error){ console.log(error); }); }, beforeUpdate(){ }, updated(){ }, beforeDestroy(){ }, destroyed(){ }, } </script> <style scoped> </style>
核心部分在 mounted 這塊
補(bǔ)充知識:vue項目api接口組織方式
一般后端接口是,一個業(yè)務(wù)的方法,用一個controller,所以前端這邊,一個業(yè)務(wù)的接口放到一個js文件里
shiroApi提供認(rèn)證相關(guān)接口,如下圖
adminApi提供組織,用戶,角色管理等相關(guān)接口,如下圖
將shiroApi和adminApi等等api做個匯總,到apis.js中,如下圖
登陸接口調(diào)用例子,引入apis.js即可(當(dāng)然也可以引入具體shiroApi.js,看自己需要和習(xí)慣),如下圖:
個人總結(jié)的api組織方式,歡迎提供更好的建議
以上這篇vue項目接口管理,所有接口都在apis文件夾中統(tǒng)一管理操作就是小編分享給大家的全部內(nèi)容了,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
elementui中使用el-tabs切換實時更新數(shù)據(jù)
這篇文章主要介紹了elementui中使用el-tabs切換實時更新數(shù)據(jù),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-08-08使用Webpack 搭建 Vue3 開發(fā)環(huán)境過程詳解
這篇文章主要介紹了使用Webpack 搭建 Vue3 開發(fā)環(huán)境過程詳解,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07Vue指令之 v-cloak、v-text、v-html實例詳解
當(dāng)用戶頻繁刷新頁面或網(wǎng)速慢時,頁面未完成 Vue.js 的加載時,導(dǎo)致 Vue 來不及渲染,這就會導(dǎo)致在瀏覽器中直接暴露插值(表達(dá)式),這篇文章主要介紹了Vue指令 v-cloak、v-text、v-html,需要的朋友可以參考下2019-08-08使用axios請求時,發(fā)送formData請求的示例
今天小編就為大家分享一篇使用axios請求時,發(fā)送formData請求的示例,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2019-10-10