web-dev-qa-db-ja.com

すべてのaxiosリクエストにAuthorizationヘッダーを添付します

APIサーバーからトークンを取得するリアクション/リデュースアプリケーションがあります。ユーザーが認証された後、アクション内のすべてのリクエストに手動で添付することなく、すべてのaxiosリクエストにAuthorizationヘッダーとしてトークンを持たせたいと思います。私はリアクション/リデュースするのはかなり新しいので、最善のアプローチについて確信が持てず、グーグルで品質のヒットを見つけていません。

私のreduxのセットアップは次のとおりです。

// actions.js
import axios from 'axios';

export function loginUser(props) {
  const url = `https://api.mydomain.com/login/`;
  const { email, password } = props;
  const request = axios.post(url, { email, password });

  return {
    type: LOGIN_USER,
    payload: request
  };
}

export function fetchPages() {
  /* here is where I'd like the header to be attached automatically if the user
     has logged in */ 
  const request = axios.get(PAGES_URL);

  return {
    type: FETCH_PAGES,
    payload: request
  };
}

// reducers.js
const initialState = {
  isAuthenticated: false,
  token: null
};

export default (state = initialState, action) => {
  switch(action.type) {
    case LOGIN_USER:
      // here is where I believe I should be attaching the header to all axios requests.
      return {
        token: action.payload.data.key,
        isAuthenticated: true
      };
    case LOGOUT_USER:
      // i would remove the header from all axios requests here.
      return initialState;
    default:
      return state;
  }
}

トークンは、state.session.tokenの下のreduxストアに保存されます。

進め方が少し迷っています。ルートディレクトリのファイルで axiosインスタンス を作成し、node_modulesからではなく更新/インポートしようとしましたが、状態が変更されたときにヘッダーが添付されません。フィードバック/アイデアは大歓迎です、ありがとう。

reactjsreduxaxios
57
awwester

これを実現する方法は複数あります。ここでは、2つの最も一般的なアプローチについて説明しました。

1. axios interceptors を使用して、リクエストをインターセプトし、認証ヘッダーを追加できます。

// Add a request interceptor
axios.interceptors.request.use(function (config) {
    const token = store.getState().session.token;
    config.headers.Authorization =  token;

    return config;
});

2. documentation of axiosから、すべてのリクエストで送信されるデフォルトのヘッダーを設定できるメカニズムがあることがわかります。

axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;

あなたの場合：

axios.defaults.headers.common['Authorization'] = store.getState().session.token;

必要に応じて、トークンがストアに存在するときに認証ヘッダー自体を設定する自己実行可能関数を作成できます。

(function() {
     String token = store.getState().session.token;
     if (token) {
         axios.defaults.headers.common['Authorization'] = token;
     } else {
         axios.defaults.headers.common['Authorization'] = null;
         /*if setting null does not remove `Authorization` header then try     
           delete axios.defaults.headers.common['Authorization'];
         */
     }
})();

トークンをすべてのリクエストに手動で添付する必要がなくなりました。上記の関数は、毎回実行されることが保証されているファイルに配置できます（e.g：ルートを含むファイル）。

それが役に立てば幸い ：）

78
Hardik Modha

私にとって最善の解決策は、トークンを使用してインスタンス化するクライアントサービスを作成し、それを使用してaxiosをラップすることです。

import axios from 'axios';

const client = (token = null) => {
    const defaultOptions = {
        headers: {
            Authorization: token ? `Token ${token}` : '',
        },
    };

    return {
        get: (url, options = {}) => axios.get(url, { ...defaultOptions, ...options }),
        post: (url, data, options = {}) => axios.post(url, data, { ...defaultOptions, ...options }),
        put: (url, data, options = {}) => axios.put(url, data, { ...defaultOptions, ...options }),
        delete: (url, options = {}) => axios.delete(url, { ...defaultOptions, ...options }),
    };
};

const request = client('MY SECRET TOKEN');

request.get(PAGES_URL);

このクライアントでは、必要に応じてlocalStorage/cookieからトークンを取得することもできます。

35
Kmaschta

「axios」：「^ 0.17.1」バージョンを使用する場合、次のようにできます。

Axiosのインスタンスを作成します。

// Default config options
  const defaultOptions = {
    baseURL: <CHANGE-TO-URL>,
    headers: {
      'Content-Type': 'application/json',
    },
  };

  // Create instance
  let instance = axios.create(defaultOptions);

  // Set the AUTH token for any request
  instance.interceptors.request.use(function (config) {
    const token = localStorage.getItem('token');
    config.headers.Authorization =  token ? `Bearer ${token}` : '';
    return config;
  });

次に、リクエストの場合、トークンはlocalStorageから選択され、リクエストヘッダーに追加されます。

私はこのコードでアプリ全体で同じインスタンスを使用しています：

import axios from 'axios';

const fetchClient = () => {
  const defaultOptions = {
    baseURL: process.env.REACT_APP_API_PATH,
    method: 'get',
    headers: {
      'Content-Type': 'application/json',
    },
  };

  // Create instance
  let instance = axios.create(defaultOptions);

  // Set the AUTH token for any request
  instance.interceptors.request.use(function (config) {
    const token = localStorage.getItem('token');
    config.headers.Authorization =  token ? `Bearer ${token}` : '';
    return config;
  });

  return instance;
};

export default fetchClient();

幸運を。

33
llioor

同様に、次のような呼び出しからトークンを設定または削除する関数があります。

import axios from 'axios';

export default function setAuthToken(token) {
  axios.defaults.headers.common['Authorization'] = '';
  delete axios.defaults.headers.common['Authorization'];

  if (token) {
    axios.defaults.headers.common['Authorization'] = `${token}`;
  }
}

初期化時に常に既存のトークンを消去してから、受信したトークンを確立します。

5
elQueFaltaba

将来、他のAPIルートを呼び出してトークンをストアに保持したい場合は、 reduxミドルウェアを使用 を試してください。

ミドルウェアはAPIアクションをリッスンし、それに応じてaxiosを介してAPI要求をディスパッチできます。

非常に基本的な例を次に示します。

actions/api.js

export const CALL_API = 'CALL_API';

function onSuccess(payload) {
  return {
    type: 'SUCCESS',
    payload
  };
}

function onError(payload) {
  return {
    type: 'ERROR',
    payload,
    error: true
  };
}

export function apiLogin(credentials) {
  return {
    onSuccess,
    onError,
    type: CALL_API,
    params: { ...credentials },
    method: 'post',
    url: 'login'
  };
}

ミドルウェア/api.js

import axios from 'axios';
import { CALL_API } from '../actions/api';

export default ({ getState, dispatch }) => next => async action => {
  // Ignore anything that's not calling the api
  if (action.type !== CALL_API) {
    return next(action);
  }

  // Grab the token from state
  const { token } = getState().session;

  // Format the request and attach the token.
  const { method, onSuccess, onError, params, url } = action;

  const defaultOptions = {
    headers: {
      Authorization: token ? `Token ${token}` : '',
    }
  };

  const options = {
    ...defaultOptions,
    ...params
  };

  try {
    const response = await axios[method](url, options);
    dispatch(onSuccess(response.data));
  } catch (error) {
    dispatch(onError(error.data));
  }

  return next(action);
};
2
Paul. B

Axiosで作成されたリクエストの一部が、認証ヘッダーを受け入れないエンドポイントを指している場合があります。したがって、許可されたドメインでのみ認証ヘッダーを設定する別の方法は、次の例のようになります。 routesファイルなどでReactアプリケーションが実行されるたびに実行されるファイルに次の関数を配置します。

export default () => {
    axios.interceptors.request.use(function (requestConfig) {
        if (requestConfig.url.indexOf(<ALLOWED_DOMAIN>) > -1) {
            const token = localStorage.token;
            requestConfig.headers['Authorization'] = `Bearer ${token}`;
        }

        return requestConfig;
    }, function (error) {
        return Promise.reject(error);
    });

}
1
Karolis Ramanauskas