摘要:在開發中,會涉及到很多接口的處理,當項目足夠大時,就需要定義規范統一的接口,如何定義呢方法可能不只一種,本文使用進行接口的統一管理本文使用生成的項目舉例舉例拿的官網簡單舉個例子,先看一下官網看下網站,腦補一下后臺給出的文檔,如果后臺不傻的
在vue開發中,會涉及到很多接口的處理,當項目足夠大時,就需要定義規范統一的接口,如何定義呢?舉例方法可能不只一種,本文使用axios+async/await進行接口的統一管理
本文使用vue-cli生成的項目舉例
拿segmentfault的官網簡單舉個例子,先看一下官網
看下網站,腦補一下后臺給出的文檔,如果后臺不傻的話給出的文檔肯定分模塊的,假設后臺給出的文檔分為了以下幾個模塊(假設的,不要較真哈)
資訊模塊 (我的訂閱、熱門資訊)
問答模塊
專欄模塊
講堂模塊
圈子模塊
發現模塊
個人信息模塊
用戶登錄注冊模塊
...還有其他很多
一般來說,網站的首頁都是復雜的,會用到很多其他頁面也會用到api,所以接口統一管理可以做到api的復用
那么如何做呢?
動手 1.首先,在src目錄下新建一個文件夾,我這里叫apis,后臺提供的所有接口都在這里定義
cd src #切換到src目錄 mkdir apis #新建apis文件2.
第二步,按照后臺文檔劃分的模塊新建js文件,這里簡單舉個例子
資訊模塊: info.js
登錄注冊模塊: member.js
個人信息模塊 user_info.js
....
cd apis #切換到apis目錄 touch info.js member.js user_info.js #新建js文件
現在的目錄大概是這個樣子
src apis info.js member.js user_info.js main.js3.
第三步,需要引入axios做相應的配置
在apis下新建一個文件夾,叫http.js,在里面做axios相應的配置
touch http.js //新建http.js文件
配置如下:
import axios from "axios" //創建axios的一個實例 var instance = axios.create({ baseURL:xxx, timeout: 6000 }) //------------------- 一、請求攔截器 忽略 instance.interceptors.request.use(function (config) { return config; }, function (error) { // 對請求錯誤做些什么 return Promise.reject(error); }); //----------------- 二、響應攔截器 忽略 instance.interceptors.response.use(function (response) { return response.data; }, function (error) { // 對響應錯誤做點什么 return Promise.reject(error); }); 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 } }
配置簡要說明一下:
引入axios,新建了個axios的實例(axios的實例的axios的功能一樣)
請求攔截器響應攔截器不是本文重點,略過
第30行代碼及以后是重點,拉出來重點看一下
/** * 使用es6的export default導出了一個函數,導出的函數代替axios去幫我們請求數據, * 函數的參數及返回值如下: * @param {String} method 請求的方法:get、post、delete、put * @param {String} url 請求的url: * @param {Object} data 請求的參數 * @returns {Promise} 返回一個promise對象,其實就相當于axios請求數據的返回值 */ 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 } }4.
第四步、在apis下面的js文件中引入http.js導出的函數,拿其中一個文件member.js說明
//member.js 用于定義用戶的登錄、注冊、注銷等 import req from "./http.js" //定義接口 //在這里定義了一個登陸的接口,把登陸的接口暴露出去給組件使用 export const LOGIN =params=>req("post","/operator/login",params) //這里使用了箭頭函數,轉換一下寫法: //export const LOGIN=function(req){ // return req("post","/operator/login",params) //} //定義注冊接口 export const REG =params=>req("post","/operator/reg",params) //定義注銷接口 export const LOGOUT =params=>req("post","/operator/logout",params)5.
第五步,在組件中使用接口
登陸組件Login.js使用登錄接口
//Login.vue6.
這樣定義接口雖然看起來麻煩點,但有以下幾個好處:
代碼看起來規范,所有的接口都在一個文件夾定義,不用分散的各個組件,維護起來簡單,例如后臺的一些url變了,改起來也方便
可以做到接口一次定義,到處使用
例如首頁使用了很多api
//index.js 首頁的js文件 import {GET_USER_INFO} from "apis/user_info.js" //用戶信息 import {GET_CURRENT_INFO,GET_HOT_INFO} from "apis/info.js" //熱門資訊 最新資訊 import {GET_HOT_LECTRUE} from"apis/lectrue.js" //講座推薦
用戶界面也會用到用戶信息api
//user_info.js用戶信息頁面 import {GET_USER_INFO} from "apis/user_info.js" //用戶信息
就先寫到這里了,如有錯誤,請在評論區指正,下次整理下用戶權限相關的內容,包括jwt,token保存和更新,頁面權限問題
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/101137.html
摘要:前端打造了前端網站和后臺管理系統。根目錄都是開發源代碼,根目錄下的文件夾下都是前端網站項目源代碼,根目錄下的文件夾下都是后臺管理系統的源代碼。后臺管理系統使用在根目錄下進入項目,安裝包,執行命令,啟動服務瀏覽器打開即可以訪問。 showImg(https://segmentfault.com/img/remote/1460000019603918); 這是個什么的項目? 使用 Node...
摘要:其實就是我們開始掛載上去的我們在這里出去,我們就可以在回調里面只處理我們的業務邏輯,而其他如斷網超時服務器出錯等均通過攔截器進行統一處理。 showImg(https://segmentfault.com/img/remote/1460000015472616?w=845&h=622); 開始之前 隨著業務的不斷累積,目前我們 ToC 端主要項目,除去 node_modules, bu...
摘要:其實就是我們開始掛載上去的我們在這里出去,我們就可以在回調里面只處理我們的業務邏輯,而其他如斷網超時服務器出錯等均通過攔截器進行統一處理。 showImg(https://segmentfault.com/img/remote/1460000015472616?w=845&h=622); 開始之前 隨著業務的不斷累積,目前我們 ToC 端主要項目,除去 node_modules, bu...
摘要:前言是現階段很流行的前端框架,很多人通過官方文檔的學習,對的使用都有了一定的了解,但再在項目工程化處理的時候,卻發現不知道改怎么更好的管理自己的項目,如何去引入一些框架以及全家桶其他框架的使用,以下將詳細地介紹本人在處理工程文件構建的過程對 前言 vue是現階段很流行的前端框架,很多人通過vue官方文檔的學習,對vue的使用都有了一定的了解,但再在項目工程化處理的時候,卻發現不知道改怎...
閱讀 3407·2023-04-26 02:41
閱讀 2454·2023-04-26 00:14
閱讀 2857·2021-08-11 10:22
閱讀 1284·2019-12-27 11:38
閱讀 3575·2019-08-29 18:34
閱讀 2384·2019-08-29 12:13
閱讀 2955·2019-08-26 18:26
閱讀 1853·2019-08-26 16:49