DEV Community

Cover image for useAxios : A simple custom hook for calling APIs using axios

useAxios : A simple custom hook for calling APIs using axios

Yogini Bende on May 18, 2021

Hello folks, Frontend apps are not complete if there are no api calls involved and calling an api becomes a little repetitive thing to do. By cre...
Collapse
 
ecyrbe profile image
ecyrbe • Edited

Hello,

here is a reviewed code for final solution :

import { useState, useEffect } from 'react';
import axios from 'axios';

axios.defaults.baseURL = 'https://jsonplaceholder.typicode.com';

/**
 fixed :
  - no need to JSON.stringify to then immediatly do a JSON.parse
  - don't use export defaults, because default imports are hard to search for
  - axios already support generic request in one parameter, no need to call specialized ones
**/
export const useAxios = (axiosParams) => {
    const [response, setResponse] = useState(undefined);
    const [error, setError] = useState('');
    const [loading, setloading] = useState(true);

    const fetchData = async (params) => {
      try {
       const result = await axios.request(params);
       setResponse(result.data);
       } catch( error ) {
         setError(error);
       } finally {
         setLoading(false);
       }
    };

    useEffect(() => {
        fetchData(axiosParams);
    }, []); // execute once only

    return { response, error, loading };
};
Enter fullscreen mode Exit fullscreen mode

and to use it :

import { useAxios } from 'axioshook';

const App = () => {
    const { response, loading, error } = useAxios({
        method: 'POST',
        url: '/posts',
        headers: { // no need to stringify
          accept: '*/*'
        },
        data: {  // no need to stringify
            userId: 1,
            id: 19392,
            title: 'title',
            body: 'Sample text',
        },
    });

    return (
        <div className='App'>
            <h1>Posts</h1>

            {loading ? (
                <p>loading...</p>
            ) : (
                <div>
                    {error && (
                        <div>
                            <p>{error.message}</p>
                        </div>
                    )}
                    <div> {
                      // no need to use another state to store data, response is sufficient
                      response && <p>{response.id}</p>
                    }
                    </div>
                </div>
            )}
        </div>
    );
};
Enter fullscreen mode Exit fullscreen mode
Collapse
 
hey_yogini profile image
Yogini Bende

This is a really good optimisation, specially the axios.request 👏
Two points to consider here -

  1. JSON.stringify and JSON.parse was used to avoid possibility of any errors.
  2. An extra state was added in the App component, as we may need to process some data coming from the api response (which is mostly the case).

Thanks for sharing this 🙌

Collapse
 
imervinc profile image
👺Mervyn

Exactly what I was thinking while reading the post XD. And maybe wrap this in React Query for an even juicier hook!

Collapse
 
ecyrbe profile image
ecyrbe

You can get it here :

httpss://github.com/ecyrbe/react-axios-query

It's juste a wrapper. Really simple.

Thread Thread
 
ayoubkhan558 profile image
Muhammad Ayoub Khan
Collapse
 
seetaram_yadav profile image
Seetaram Yadav • Edited

There is small syntax error in losing callback. instead of setloading it should be setLoading. `import { useState, useEffect } from 'react';
import axios from 'axios';

axios.defaults.baseURL = 'jsonplaceholder.typicode.com';

/**
fixed :

  • no need to JSON.stringify to then immediatly do a JSON.parse
  • don't use export defaults, because default imports are hard to search for
  • axios already support generic request in one parameter, no need to call specialized ones **/

`import { useState, useEffect } from 'react';
import axios from 'axios';

axios.defaults.baseURL = 'jsonplaceholder.typicode.com';

/**
fixed :

  • no need to JSON.stringify to then immediatly do a JSON.parse
  • don't use export defaults, because default imports are hard to search for
  • axios already support generic request in one parameter, no need to call specialized ones
    **/
    export const useAxios = (axiosParams) => {
    const [response, setResponse] = useState(undefined);
    const [error, setError] = useState('');
    const [loading, setLoading] = useState(true);

    const fetchData = async (params) => {
    try {
    const result = await axios.request(params);
    setResponse(result.data);
    } catch( error ) {
    setError(error);
    } finally {
    setLoading(false);
    }
    };

    useEffect(() => {
    fetchData(axiosParams);
    }, []); // execute once only

    return { response, error, loading };
    };`

Collapse
 
matek075 profile image
Matek

Hi, small fix:
here const [loading, setloading] = useState(true);
to const [loading, setLoading] = useState(true);

upperCase "L"

Greetings

Collapse
 
kamrulhasan12345 profile image
Mohammad Kamrul Hasan

A correction:
Add axiosParams to the empty list in the second param of the useEffect hook. This will remove a dependency error

Collapse
 
peng profile image
Peng

Wow

Collapse
 
bernasantolin profile image
Antolin B. Bernas Jr.

sir what if the structure has axios interceptor and header is with bearer token?

Collapse
 
dastasoft profile image
dastasoft

Nice article and well explained! If you want to go further with the hook I always recommend this article of Kent C Dodds about not using booleans for loading

Collapse
 
hey_yogini profile image
Yogini Bende

Yes, that is also a good approach. But, if I am using reducers, I just go with states as reducers help us updating states synchronously.

Collapse
 
dastasoft profile image
dastasoft

Reducers can also be useful when the different states are closely related, although both options are good in this case :)

Collapse
 
embrycode profile image
Mason Embry

I believe your fetchData function is getting recreated on every render of the hook. Consider moving it into a useCallback. I'm curious what other people think about that or if I'm missing something. Nice hook!

Collapse
 
ecyrbe profile image
ecyrbe • Edited

useCallback don't magically make the function not being recreated... it just makes sure the instance created the first time is used the second time, etc... but unfortunately function creation is still done at runtime, so no performance gain from using useCallback.

So you should only use useCallback if you need a stable function instance for referencing in another component.

Since fetchData is only used internally and not exposed outside the hook, useCallback will in fact bring a memory cost and no performance gain.

See this article or this one for another explanation

Collapse
 
embrycode profile image
Mason Embry

Yeah, I knew the primary purpose of useCallback was for a stable reference but I also thought it was important in some cases for performance reasons. Those articles are helpful for understanding that that's not a big deal. Thanks!

Collapse
 
hey_yogini profile image
Yogini Bende

Really good explanation here! Even I wondered initially if useCallback will make any difference. Thanks for sharing!

Collapse
 
Sloan, the sloth mascot
Comment deleted
Collapse
 
hey_yogini profile image
Yogini Bende

Any issue occurred? Can you please share details?

Collapse
 
dougantr profile image
Douglas Trofino

Nice hook!
I will try that in my projects. Thank you for sharing!
I just would return the hooks states as an array, so I can rename it.

return [ response, error, loading ];

const [ products, productsError, productsLoading ] = useAxios(params);

In case a I need more than one api request in the same component, I can differentiate them.

Collapse
 
steventhan profile image
Steven Than

You can rename with object returns as well

const { response: products, loading: productsLoading, error: productsError } = useAxios(...)
Enter fullscreen mode Exit fullscreen mode
Collapse
 
hey_yogini profile image
Yogini Bende

Hey, that's a nice improvement!

Collapse
 
jamesburton profile image
James Burton

Other potential enhancements:
Add local storage and stale state cache, to show stale whilst loading new version.
Add withAxios HOC to wrap and inject these properties into any "dumb" component.
Provide an example extending the hook to tailored hooks:
const usePost = id => useAxios('/api/posts/' + id);
... It's an option for grouping your data access into a secondary layer, so components then just hooks the most basic hooks.
Providing examples to disable/mock the fetch in unit tests is a handy one to consider ... Storybook too ... Like having a testData parameter which is used if typeof window != 'object', or jest mocking.
Finally a withAxiosDisplay HOC could wrap that with a loader overlay, loading spinner or skeleton display, error display, and then child component, so you get this:
let Post = ({data}) => {
// Just render from data
};
const Post123 = withAxiosDisplay('/api/post/123', Post):
// Render
... Loading display, error handler, retry and passing data then all included.

Collapse
 
anastawfik profile image
Anas Tawfik

wow, great job that looks nice, but it might be impractical to use for POST methods as you want to control the triggering of the request, like when user submit a form, but hooks are triggered once the component is loaded and you can't use it inside a function or a condition,
what about implementing same as Apollo does, if the method is POST, you dont trigger the fetchData yourself, but return it with the other variables.

I also agree with the comment below that suggest using an array so we can rename it on use, so it can be used multiple times same component, like GET the saved form values, then POST after the user fill the rest of the form and submit

Collapse
 
amanzx4 profile image
AmanZrx4

I was thinking the same, but then even if we return the fetch method, we just cannot use a custom hook inside an event handler. Then we have to revert back to a normal js function or a fetch component, no more a custom hook. React is weird. I didn't find any standard way to achieve this

Collapse
 
itayperry profile image
Itay

I've used this solution with TypeScript and added an option to cancel the request:

import axios, { AxiosError, AxiosRequestConfig } from 'axios';
import { useEffect, useRef, useState } from 'react';
import { environment } from '../../environments/environment';

axios.defaults.baseURL = environment.baseUrl;

/**
 * Generic T: represents the data returned from API request.
 *
 * Generic D: represents the body data of the Axios
 * request (usually does not exist in GET method).
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export const useAxios = <T, D = any>(axiosParams: AxiosRequestConfig<D>) => {
  const [response, setResponse] = useState<T | null>(null);
  const [error, setError] = useState<AxiosError | unknown>();
  const [loading, setLoading] = useState(true);
  const controllerRef = useRef(new AbortController());
  const cancelRequest = () => {
    controllerRef.current.abort();
  };

  useEffect(() => {
    const fetchData = async (params: AxiosRequestConfig<D>) => {
      try {
        const result = await axios.request<T>({
          ...params,
          signal: controllerRef.current.signal,
        });
        setResponse(result.data);
      } catch (err: AxiosError | unknown) {
        if (axios.isAxiosError(err)) {
          setError(err);
          // this will narrow the type :)
          // Access to config, request, and response
        } else {
          setError(err);
          // Just a stock error
        }
      } finally {
        setLoading(false);
      }
    };

    fetchData(axiosParams);
  }, [axiosParams]);

  return { cancelRequest, response, error, loading };
};
Enter fullscreen mode Exit fullscreen mode
Collapse
 
brayanarrieta profile image
Brayan Arrieta

nice post I recommend a change from then/catch to async/await approach

Collapse
 
rajvirs99 profile image
Rajvir Singh

Hello,
This is good. However, I want to ask if I want to use in onClick function. Something like calling the hook on user login. How can we do it ?

Collapse
 
ayoubkhan558 profile image
Muhammad Ayoub Khan

I also want this.

Collapse
 
narven profile image
Pedro Luz

Never understood quite the use of hooks like this. Requests should not be made from inside components, mainly due to separation of concerns and specially in the case that you might need to make the same request from multiple places in you application. So would you use that twice in 2 diferent components?

The only point I see in using this is for a quick prototype to trash the next day.

Personally since I also use redux-sagas, there is usage for me.

But still a good tutorial :)

Collapse
 
joaorr3 profile image
João Ribeiro

Nice! But it's more useful to export a fetch action instead of the data. This way you can fetch data when you need it instead of doing it only on mount. You also need something like redux or context to set/get the api response.

Collapse
 
jace profile image
Jace Chou • Edited

Nice hook!

import { useState, useEffect } from 'react';
import axios from 'axios';

axios.defaults.baseURL = 'https://jsonplaceholder.typicode.com';

const useAxios = ({ url, method, body = null, headers = null, config = {} }) => {
    ...

    const fetchData = () => {
        axios[method](url, JSON.parse(headers), JSON.parse(body), ...config)
            .then((res) => {
                setResponse(res.data);
            })
            .catch((err) => {
                setError(err);
            })
            .finally(() => {
                setloading(false);
            });
    };

    useEffect(() => {
        fetchData();
    }, [method, url, body, headers, config]);

    return { response, error, loading };
};

export default useAxios;
Enter fullscreen mode Exit fullscreen mode

In component:

// App component
import { CancelToken } from 'axios';

const App = () => {
    const source = CancelToken.source()
    const { response, loading, error } = useAxios({
        method: 'post',
        url: '/posts',
        headers: JSON.stringify({ accept: '*/*' }),
        config: {
            cancelToken: source.token,
        },
        body: JSON.stringify({
            userId: 1,
            id: 19392,
            title: 'title',
            body: 'Sample text',
        }),
    });
    ...

    source.cancel('cancel request')

}

Enter fullscreen mode Exit fullscreen mode
Collapse
 
imageck profile image
imageck

Unfortunately, I have to admit that this custom hook is futile and impractical. Could you please give a real-life example instead of making a request manually like useAxios({ data: "HAHA look" })?

Like @anastawfik mentioned, it's not possible to call this hook inside a JavaScript function, i.e. the submit handler, which is like 90% of cases where we would need such a hook in the first place.

In any case, it's more to do with React.

Collapse
 
okayhead profile image
Shashwat jaiswal

A little modification and you can use it on click.

Read here

Collapse
 
clysto profile image
毛亚琛

try use swr

Collapse
 
mzxryuzaki profile image
Alexandro Arauco

Great example, but i have a some question.

How can invoke this custom Hook from a button? (Post Request)

Collapse
 
alxizr profile image
alxizr

you need to learn about react query or useSWR.

Collapse
 
hey_yogini profile image
Yogini Bende

noted 😇

Collapse
 
abhay5855 profile image
Abhay Patil

I made a get call to fetch the posts using get method, but I want to make a post reuest when user clicks on Add button , so I am calling the hook as ->

 const HandleAdd = () => {

    const { data, loading, error } = useApi({
        method: 'post',
        url: '/posts',
        headers: JSON.stringify({ accept: '*/*' }),
        body: JSON.stringify({
            userId: 1,
            id: 19392,
            title: 'title',
            body: 'Sample text',
        }),
    });  
 }
Enter fullscreen mode Exit fullscreen mode

this is causing error , how can I make a post request then.
codesandbox.io/s/currying-bush-yic...

Collapse
 
bushblade profile image
Will Adams

Interesting, though a few things I'm not clear on.

  1. Why not use an instance of axios instead of setting defaults?
  2. Axios stringifies and parses JSON for you, so why did you stringify and parse?
  3. Why do you have local state in App when it's the same data as the response you get from your hook? I don't see any reason for duplicating it or using state or useEffect in App.
Collapse
 
melfordd profile image
Melford Birakor

Worth Reading! ❤️

Collapse
 
alxizr profile image
alxizr

you need to learn about react query or useSWR

Collapse
 
dimer191996 profile image
Dimer Bwimba • Edited

what if I want to submit something... kindda confusing!

Collapse
 
tuvudu profile image
Tuyen Vd.

it will better if you handle load more in your custom hook

Collapse
 
dunggramer profile image
Nguyễn Công Dũng

I have a error in useEffect. How to fixed?

React Hook useEffect has a missing dependency: 'fetchData'. Either include it or remove the dependency array.eslintreact-hooks/exhaustive-deps
Enter fullscreen mode Exit fullscreen mode
Collapse
 
hullen profile image
Hullen Gonzales

You can disable it with a comment // eslint-disable-next-line react-hooks/exhaustive-deps. Because fetchData need to be called only on mount component cycle.

Collapse
 
jamesburton profile image
James Burton

If you want to make it even more advanced, simply load up axios-retry and configure exponential falloff retries in the hook too:

github.com/softonic/axios-retry

Collapse
 
jilvanx profile image
Jilvan Cândido

Very nice article, simple and direct to the point.

Congrats and keep writing!

Collapse
 
jeremydmarx813 profile image
Jeremy Marx

Nice!

Collapse
 
jlizanab profile image
José Lizana

Thanks, nice code !!!

Collapse
 
vaibhavkhulbe profile image
Vaibhav Khulbe

Simple and clear explanations! Thank you for your efforts.

Keep writing!

Collapse
 
ftinoco profile image
Fernando Tinoco

@ms_yogii how would you write unit tests for this custom hook?

Collapse
 
mercurio236 profile image
Arley Souto

Thank you it helped me a lot

Collapse
 
amalshehu profile image
Amal Shehu

Cool stuff 👍

Collapse
 
aitweet01 profile image
©️hukwue🅱️uk🅰️

Your articles are very lively and interesting

Collapse
 
hey_yogini profile image
Yogini Bende

Thank you so much!

Collapse
 
filbryancegos profile image
Fil Bryan C. Egos

very usefull thanks

Collapse
 
srisrinu_ profile image
srinivas-challa1

Finally i found what i needed thank you for the nice blog

Collapse
 
stepanbokhanov profile image
alphadev

I tried to use this code snippets and got cors error.
How to fix it?

Collapse
 
lisan profile image
wuzhao

nice, good useful

Collapse
 
ehsanshv profile image
Ehsan Shahvirdi

It's great, but do you have any idea to add request cancellation feature to this hook?

Some comments have been hidden by the post's author - find out more