Custom instance

You can add a mutator function to your config and setup a custom instance of axios.

1 module.exports = {
2   petstore: {
3     output: {
4       ...
5       override: {
6         mutator: {
7           path: './api/mutator/custom-instance.ts',
8           name: 'customInstance',
9         },
10       },
11     }
12     ...
13   },
14 };

1 // custom-instance.ts
2 
3 import Axios, { AxiosRequestConfig } from 'axios';
4 
5 export const AXIOS_INSTANCE = Axios.create({ baseURL: '<BACKEND URL>' }); // use your own URL here or environment variable
6 
7 // add a second `options` argument here if you want to pass extra options to each generated query
8 export const customInstance = <T>(
9   config: AxiosRequestConfig,
10   options?: AxiosRequestConfig,
11 ): Promise<T> => {
12   const source = Axios.CancelToken.source();
13   const promise = AXIOS_INSTANCE({
14     ...config,
15     ...options,
16     cancelToken: source.token,
17   }).then(({ data }) => data);
18 
19   // @ts-ignore
20   promise.cancel = () => {
21     source.cancel('Query was cancelled');
22   };
23 
24   return promise;
25 };
26 
27 // In some case with react-query and swr you want to be able to override the return error type so you can also do it here like this
28 export type ErrorType<Error> = AxiosError<Error>;
29 
30 export type BodyType<BodyData> = BodyData;
31 
32 // Or, in case you want to wrap the body type (optional)
33 // (if the custom instance is processing data before sending it, like changing the case for example)
34 export type BodyType<BodyData> = CamelCase<BodyData>;