e-code接口api拦截教程

e-code通用接口拦截概述

概述

  #接口拦截用处
  可以针对前端的接口请求进行拦截,进行一些自定义开发

  #接口请求前拦截
    可以增加data、或者url 的params参数
  #接口响应后拦截
  可以修改响应数据、或者追加数据

e-code通用接口拦截代码示例

通用接口请求前拦截

  
import axios from 'axios';

//定义参数
const appendParams = { // key 为url的前缀匹配,按次序往下匹配,匹配到一个就停止
  '/api/esearch/search/fullsearch/searchByModule': {
    data: { // 附加的data参数
      appendData: 'ecode附加的data参数'
    },
    params: { // 附加的路径参数
      appendData: 'ecode附加的params参数'
    }
  }
}

/**
 * 定义请求拦截
 */
axios.interceptors.request.use((config) => {
  try {
    const { url, data, params } = config;
    //处理你的参数逻辑
    for (const k of Object.keys(appendParams)) {
      if (url.startsWith(k)) { // 路径前缀匹配
        if (appendParams[k].data) {
            config.data = Object.assign(data, appendParams[k].data || {});
            console.info('添加data数据 => ', config.data);
        }
        if (appendParams[k].params) {
            config.params = Object.assign(params || {}, appendParams[k].params || {});
        }
        //返回重写后的参数对象
        return config;
      }
    }
  } catch (e) {
     //重要,不能影响系统其他功能
    console.error('通用全局请求拦截异常 => ', e);
  }
  //返回原始参数对象
  return config;
});

通用接口响应后拦截

import axios from 'axios';

//定义参数
const appendResponseData = {
  '/api/workflow/list/total/getMineListTotal': {
    'ecodeAppendData': 'ecode-响应拦截添加的数据'
  }
}

/**
 * 定义响应拦截
 * 可以给响应结果附加结果,也可以进行错误统一处理
 */
axios.interceptors.response.use((response) => {
  const { config } = response;
  const { data, url } = config;
   //处理你的参数逻辑
  for (const k of Object.keys(appendResponseData)) {
    if (url.startsWith(k)) { // 路径前缀匹配
      if (appendResponseData[k]) {
        console.info(response.data);
        response.data = Object.assign(response.data, appendResponseData[k]);
        console.info('添加resp data数据 => ', response.data);
      }
    }
  }
   //返回重写后的参数对象
  return response;
}, function (error) {
   //重要,必须返回错误信息
  console.info('接口请求出错啦', error);
  return Promise.reject(error)
});