Fast, lightweight and reusable data fetching
Managing multiple API endpoints can be complex and time-consuming. axios-multi-api
simplifies this process by offering a straightforward, declarative approach to API handling using Repository Pattern. It reduces the need for extensive setup and middlewares, allowing developers to focus on data manipulation and application logic.
Key Benefits:
✅ Simplicity: Minimal code footprint for managing extensive APIs.
✅ Productivity: Streamlines API interactions, enhancing developer efficiency.
✅ Scalability: Easily scales from a few endpoints to complex API networks.
- 100% Performance-Oriented: Optimized for speed and efficiency, ensuring fast and reliable API interactions.
- Fully TypeScript Compatible: Enjoy full TypeScript support for better development experience and type safety.
- Smart Error Retry: Features exponential backoff for intelligent error handling and retry mechanisms.
- Dynamic URLs Support: Easily manage routes with dynamic parameters, such as
/user/:userId
. - Native
fetch()
Support: Uses the modernfetch()
API by default, eliminating the need for Axios. - Global and Per Request Error Handling: Flexible error management at both global and individual request levels.
- Automatic Request Cancellation: Utilizes
AbortController
to cancel previous requests automatically. - Global and Per Request Timeouts: Set timeouts globally or per request to prevent hanging operations.
- Multiple Fetching Strategies: Handle failed requests with various strategies - promise rejection, silent hang, soft fail, or default response.
- Multiple Requests Chaining: Easily chain multiple requests using promises for complex API interactions.
- Supports All Axios Options: Fully compatible with all Axios configuration options for seamless integration.
- Lightweight: Minimal footprint, only a few KBs when gzipped, ensuring quick load times.
- Framework Independent: Pure JavaScript solution, compatible with any framework or library.
- Browser and Node 18+ Compatible: Works flawlessly in both modern browsers and Node.js environments.
- Custom Interceptors: Includes
onRequest
,onResponse
, andonError
interceptors for flexible request and response handling.
Please open an issue for future requests.
Using NPM:
npm install axios-multi-api
Using Pnpm:
pnpm install axios-multi-api
Using Yarn:
yarn add axios-multi-api
import { fetchf } from 'axios-multi-api';
const { data } = await fetchf('/api/user-details');
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
strategy: 'softFail', // no try/catch required
endpoints: {
getUser: {
method: 'get',
url: '/user-details',
},
},
});
// Make API GET request to: http://example.com/api/user-details?userId=1&ratings[]=1&ratings[]=2
const { data, error } = await api.getUser({ userId: 1, ratings: [1, 2] });
Note:
The native
fetch()
is used by default. If you want to use Axios, install it separately (e.g.npm install axios
), and then pass the import to thecreateApiFetcher()
function. Check examples for more details.
axios-multi-api
is designed to seamlessly integrate with popular libraries like React Query and SWR. Whether you're using React Query or SWR, you can effortlessly manage API requests with minimal setup.
Integrate axios-multi-api
with React Query to streamline your data fetching:
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
endpoints: {
getProfile: {
url: '/profile/:id',
},
},
});
export const useProfile = ({ id }) => {
return useQuery(['profile', id], () => api.getProfile({ id }));
};
Combine axios-multi-api
with SWR for efficient data fetching and caching:
import { createApiFetcher } from 'axios-multi-api';
import useSWR from 'swr';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
endpoints: {
getProfile: {
url: '/profile/:id',
},
},
});
export const useProfile = ({ id }) => {
const fetcher = () => api.getProfile({ id });
const { data, error } = useSWR(['profile', id], fetcher);
return {
profile: data,
isLoading: !error && !data,
isError: error,
};
};
Check examples below for more integrations with other libraries.
fetchf()
is a functional wrapper for fetch()
. It integrates seamlessly with the retry mechanism and error handling improvements. Unlike the traditional class-based approach, fetchf()
can be used directly as a function, simplifying the usage and making it easier to integrate with functional programming styles.
import { fetchf } from 'axios-multi-api';
const { data, error } = await fetchf('/api/user-details', {
timeout: 5000,
cancellable: true,
retry: { retries: 3, delay: 2000 },
// All other fetch() settings work as well...
});
The fetchf() makes requests independently from createApiFetcher()
Challenges with Native Fetch:
- Error Status Handling: Fetch does not throw errors for HTTP error statuses, making it difficult to distinguish between successful and failed requests based on status codes alone.
- Error Visibility: Error responses with status codes like 404 or 500 are not automatically propagated as exceptions, which can lead to inconsistent error handling.
To address these challenges, the fetchf()
provides several enhancements:
-
Consistent Error Handling:
- In JavaScript, the native
fetch()
function does not reject the Promise for HTTP error statuses such as 404 (Not Found) or 500 (Internal Server Error). Instead,fetch()
resolves the Promise with aResponse
object, where theok
property indicates the success of the request. If the request encounters a network error or fails due to other issues (e.g., server downtime),fetch()
will reject the Promise. - This approach aligns error handling with common practices and makes it easier to manage errors consistently.
- In JavaScript, the native
-
Enhanced Retry Mechanism:
- Retry Configuration: You can configure the number of retries, delay between retries, and exponential backoff for failed requests. This helps to handle transient errors effectively.
- Custom Retry Logic: The
shouldRetry
asynchronous function allows for custom retry logic based on the error and attempt count, providing flexibility to handle different types of failures. - Retry Conditions: Errors are only retried based on configurable retry conditions, such as specific HTTP status codes or error types.
-
Improved Error Visibility:
- Error Wrapping: The
createApiFetcher()
andfetchf()
wrap errors in a customRequestError
class, which provides detailed information about the request and response, similarly to what Axios does. This makes debugging easier and improves visibility into what went wrong.
- Error Wrapping: The
-
Extended settings:
- Check Settings table for more information about all settings.
createApiFetcher()
is a powerful factory function for creating API fetchers with advanced features. It provides a convenient way to configure and manage multiple API endpoints using a declarative approach. This function offers integration with retry mechanisms, error handling improvements, and other advanced configurations. Unlike traditional methods, createApiFetcher()
allows you to set up and use API endpoints efficiently with minimal boilerplate code.
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
endpoints: {
getUserDetails: {
url: '/user-details',
method: 'GET',
retry: { retries: 3, delay: 2000 },
timeout: 5000,
cancellable: true,
strategy: 'softFail',
},
updateUser: {
url: '/update-user',
method: 'POST',
retry: { retries: 2, delay: 1000 },
},
// Define more endpoints as needed
},
});
// Example usage
const { data, error } = await api.getUserDetails();
The const api
methods and properties are described below:
Where "myEndpoint" is the name of your endpoint from endpoints
object passed to the createApiFetcher()
.
-
queryParams
/payload
(optional) - Query Parameters or Body Payload for POST requests. First argument of API functions is an object with query params forGET
requests, or with a data payload forPOST
alike requests. Other request types are supported as well. ForPOST
alike requests you may occasionally want to use both query params and payload. In such case, use this argument as query params and pass the payload as 3rd argumentrequestConfig.body
orrequestConfig.data
(for Axios) Query params accepts strings, numbers, and even arrays, so you pass { foo: [1, 2] } and it will become: foo[]=1&foo[]=2 automatically. -
urlPathParams
(optional) - Dynamic URL Path Parameters It gives possibility to modify URLs structure in a declarative way. In our example/user-details/update/:userId
will become/user-details/update/1
when API request will be made. -
requestConfig
(optional) - Request Configuration to overwrite global config in case To have more granular control over specific endpoints you can pass Axios compatible Request Config for particular endpoint. You can also use Global Settings likecancellable
orstrategy
and others mentioned below.
Returns: response
or data
object, depending on flattenResponse
setting:
When flattenResponse
is disabled, the response object includes a more detailed structure, encapsulating various aspects of the response:
-
data
:- Contains the actual data returned from the API request.
-
error
:- An object with details about any error that occurred or
null
otherwise. name
: The name of the error (e.g., 'ResponseError').message
: A descriptive message about the error.status
: The HTTP status code of the response (e.g., 404, 500).statusText
: The HTTP status text of the response (e.g., 'Not Found', 'Internal Server Error').request
: Details about the HTTP request that was sent (e.g., URL, method, headers).config
: The configuration object used for the request, including URL, method, headers, and query parameters.response
: The full response object received from the server, including all headers and body.
- An object with details about any error that occurred or
-
config
:- The configuration object with all settings used for the request, including URL, method, headers, and query parameters.
-
request
:- An alias for
config
.
- An alias for
-
headers
:- The response headers returned by the server, such as content type and caching information returned as simple key-value object.
When the flattenResponse
option is enabled, the data
from the API response is directly exposed as the top-level property of the response object. This simplifies access to the actual data, as it is not nested within additional response metadata.
-
With
flattenResponse
Enabled:data
: Directly contains the API response data.
-
With
flattenResponse
Disabled:data
: Contains the API response data nested within a broader response structure.error
: Provides detailed information about any errors encountered.config
: Shows the request configuration.request
: Details the actual HTTP request sent.headers
: Includes the response headers from the server.
The flattenResponse
option provides a more streamlined response object by placing the data directly at the top level, while disabling it gives a more comprehensive response structure with additional metadata.
You can access api.config
property directly, so to modify global headers, and other settings on fly. Please mind it is a property, not a function.
You can access api.endpoints
property directly, so to modify endpoints list. It can be useful if you want to append or remove global endpoints. Please mind it is a property, not a function.
When API handler is firstly initialized, a new custom fetcher
instance is created. You can call api.getInstance()
if you want to get that instance directly, for example to add some interceptors. The instance of fetcher
is created using fetcher.create()
functions. Your fetcher can include anything. It will be triggered instead of native fetch() that is available by default.
The api.request()
helper function is a versatile method provided for making API requests with customizable configurations. It allows you to perform HTTP requests to any endpoint defined in your API setup and provides a straightforward way to handle queries, path parameters, and request configurations dynamically.
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
endpoints: {
getUserDetails: {
url: '/user-details/:id',
method: 'GET',
},
updateUser: {
url: '/update-user',
method: 'POST',
},
// Define more endpoints as needed
},
});
// Using api.request to make a GET request
const { data, error } = await api.request(
'getUserDetails',
null, // no Query Params passed
{
id: '123', // URL Path Param :id
},
);
// Using api.request to make a POST request
const { data, error } = await api.request('updateUser', {
name: 'John Doe', // Data Payload
});
// Using api.request to make a GET request to an external API
const { data, error } = await api.request('https://example.com/api/user', {
name: 'John Smith', // Query Params
});
Global settings are passed to createApiFetcher()
function. Settings that are global only are market with star *
next to setting name.
Almost all settings can be passed on per-request basis in the third argument of endpoint function, for example api.getUser({}, {}, { /* Request Config */ })
.
You can also pass all fetch()
settings, or if you use Axios, you can pass all Axios Request Config settings.
Setting | Type | Default | Description |
---|---|---|---|
apiUrl * | string | Your API base url. | |
endpoints * | object | List of your endpoints. Each endpoint accepts all these settings. They can be set globally or per-endpoint when they are called. | |
fetcher * | AxiosStatic | fetch | The native fetch() is used by default. Axios instance imported from axios package can be used otherwise. Leave as is, if you do not intend to use Axios. |
strategy | string | reject | Error handling strategies - basically what to return when an error occurs. It can be a default data, promise can be hanged (nothing would be returned) or rejected so to use try/catch. Available: reject , softFail , defaultResponse , silent .reject - Promises are rejected, and global error handling is triggered. Requires try/catch for handling.softFail - returns a response object with additional properties such as data , error , config , request , and headers when an error occurs. This approach avoids throwing errors, allowing you to handle error information directly within the response object without the need for try/catch blocks.defaultResponse - returns default response specified in case of an error. Promise will not be rejected. It could be used in conjuction with flattenResponse and as defaultResponse: {} so to provide a sensible defaults.silent - hangs the promise silently on error, useful for fire-and-forget requests without the need for try/catch. In case of an error, the promise will never be resolved or rejected, and any code after will never be executed. The requests could be dispatched within an asynchronous wrapper functions that do not need to be awaited. If used properly, it prevents excessive usage of try/catch or additional response data checks everywhere. You can use it in combination with onError to handle errors separately. |
cancellable | boolean | false | If true , any previous requests to same API endpoint will be cancelled, if a subsequent request is made meanwhile. This helps you avoid unnecessary requests to the backend. |
rejectCancelled | boolean | false | If true and request is set to cancellable , a cancelled requests' promise will be rejected. By default, instead of rejecting the promise, defaultResponse is returned. |
flattenResponse | boolean | false | Flatten nested response data, so you can avoid writing response.data.data and obtain response directly. Response is flattened when there is a "data" within response "data", and no other object properties set. |
defaultResponse | any | null | Default response when there is no data or when endpoint fails depending on the chosen strategy |
timeout | int | 30000 | You can set a request timeout for all requests or particular in milliseconds. |
onRequest | function(config) | You can specify a function that will be triggered before the request is sent. The request configuration object will be sent as the first argument of the function. This is useful for modifying request parameters, headers, etc. | |
onResponse | function(response) | You can specify a function that will be triggered when the endpoint successfully responds. The full Response Object is sent as the first argument of the function. This is useful for handling the response data, parsing, and error handling based on status codes. | |
onError | function(error) | You can specify a function or class that will be triggered when endpoint fails. If it's a class it should expose a process method. When using native fetch(), the full Response Object is sent as a first argument of the function. In case of Axios, AxiosError object is sent. |
|
logger | object | You can additionally specify logger object with your custom logger to automatically log the errors to the console. It should contain at least error and warn functions. console.log is used by default. |
|
method | string | get | Default request method e.g. GET, POST, DELETE, PUT etc. |
url | string | URL path e.g. /user-details/get | |
urlPathParams | object | {} | An object representing URL path parameters. These parameters are used to dynamically replace placeholders in the URL path. For example, if your URL contains a placeholder like /users/:userId , you can provide an object with the userId key to replace that placeholder with an actual value. The keys in the urlPathParams object should match the placeholders in the URL. This allows for dynamic URL construction based on runtime values. |
retry | object | The object with retry settings available below. | |
retry.retries | number | 0 | The number of times to retry the request in case of failure. If set to 0 (default), no retries will be attempted. |
retry.delay | number | 1000 | The initial delay (in milliseconds) between retry attempts. |
retry.backoff | number | 1.5 | The backoff factor to apply to the delay between retries. For example, if the delay is 100ms and the backoff is 1.5, the next delay will be 150ms, then 225ms, and so on. |
retry.maxDelay | number | 30000 | The maximum delay (in milliseconds) between retry attempts. |
retry.retryOn | array | [408, 409, 425, 429, 500, 502, 503, 504] | An array of HTTP status codes on which to retry the request. Default values include: 408 (Request Timeout), 409 (Conflict), 425 (Too Early), 429 (Too Many Requests), 500 (Internal Server Error), 502 (Bad Gateway), 503 (Service Unavailable), 504 (Gateway Timeout). |
retry.shouldRetry | async function | A custom asynchronous function to determine whether to retry the request. It receives two arguments: error (the error object) and attempts (the number of attempts made so far). |
The exposed fetchf()
and createApiFetcher()
functions include a built-in retry mechanism to handle transient errors and improve the reliability of network requests. This mechanism automatically retries requests when certain conditions are met, providing robustness in the face of temporary failures. Below is an overview of how the retry mechanism works and how it can be configured.
The retry mechanism is configured via the retry
option when instantiating the RequestHandler
. You can customize the following parameters:
-
retries
: Number of retry attempts to make after an initial failure. Default is0
which means not to retry any requests. -
delay
: Initial delay (in milliseconds) before the first retry attempt. Subsequent retries use an exponentially increasing delay based on thebackoff
parameter. Default is1000
. -
maxDelay
: Maximum delay (in milliseconds) between retry attempts. The delay will not exceed this value, even if the exponential backoff would suggest a longer delay. Default is30000
. -
backoff
: Factor by which the delay is multiplied after each retry. For example, abackoff
factor of1.5
means each retry delay is 1.5 times the previous delay. Default is1.5
. -
retryOn
: Array of HTTP status codes that should trigger a retry. By default, retries are triggered for the following status codes:408
- Request Timeout409
- Conflict425
- Too Early429
- Too Many Requests500
- Internal Server Error502
- Bad Gateway503
- Service Unavailable504
- Gateway Timeout
-
shouldRetry(error, attempts)
: Function that determines whether a retry should be attempted based on the error and the current attempt number. This function receives the error object and the attempt number as arguments.
-
Initial Request: When a request fails, the retry mechanism captures the failure and checks if it should retry based on the
retryOn
configuration and the result of theshouldRetry
function. -
Retry Attempts: If a retry is warranted:
- The request is retried up to the specified number of attempts (
retries
). - Each retry waits for a delay before making the next attempt. The delay starts at the initial
delay
value and increases exponentially based on thebackoff
factor, but will not exceed themaxDelay
.
- The request is retried up to the specified number of attempts (
-
Logging: During retries, the mechanism logs warnings indicating the retry attempts and the delay before the next attempt, which helps in debugging and understanding the retry behavior.
-
Final Outcome: If all retry attempts fail, the request will throw an error, and the final failure is processed according to the configured error handling logic.
Check Examples section below for more information.
Feature | axios-multi-api | ofetch() | Wretch() | Axios | Native fetch() |
---|---|---|---|---|---|
Unified API Client | ✅ | -- | -- | -- | -- |
Customizable Error Handling | ✅ | -- | ✅ | ✅ | -- |
Retries with exponential backoff | ✅ | -- | -- | -- | -- |
Easy Timeouts | ✅ | ✅ | ✅ | ✅ | -- |
Easy Cancellation | ✅ | -- | -- | -- | -- |
Default Responses | ✅ | -- | -- | -- | -- |
Global Configuration | ✅ | -- | ✅ | ✅ | -- |
TypeScript Support | ✅ | ✅ | ✅ | ✅ | ✅ |
Interceptors | ✅ | ✅ | ✅ | ✅ | -- |
Request and Response Transformation | ✅ | ✅ | ✅ | ✅ | -- |
Integration with Libraries | ✅ | ✅ | ✅ | ✅ | -- |
Request Queuing | ✅ | -- | -- | -- | -- |
Multiple Fetching Strategies | ✅ | -- | -- | -- | -- |
Dynamic URLs | ✅ | -- | ✅ | -- | -- |
Automatic Retry on Failure | ✅ | ✅ | -- | ✅ | -- |
Server-Side Rendering (SSR) Support | ✅ | ✅ | -- | -- | -- |
Minimal Installation Size | 🟢 (2.83 KB) | 🟡 (6.51 KB) | 🟢 (2.16 KB) | 🔴 (13.9 KB) | 🟢 (0 KB) |
Built-in AbortController Support | ✅ | -- | -- | -- | -- |
Please mind that this table is for informational purposes only. All of these solutions differ. For example swr
and react-query
are more focused on React, re-rendering, query caching and keeping data in sync, while fetch wrappers like axios-multi-api
or ofetch
aim to extend functionalities of native fetch
so to reduce complexity of having to maintain various wrappers.
Axios-multi-api includes all necessary TypeScript definitions bringing full TypeScript support to your API Handler. The package ships interfaces with responsible defaults making it easier to add new endpoints.
import type { DefaultEndpoints } from 'axios-multi-api';
import { createApiFetcher } from 'axios-multi-api';
interface Book {
id: number;
title: string;
rating: number;
}
interface Books {
books: Book[];
totalResults: number;
}
interface BookQueryParams {
newBook: boolean;
}
interface BookPathParams {
bookId?: number;
}
const endpoints = {
fetchBooks: {
url: 'books',
},
fetchBook: {
url: 'books/:bookId',
},
};
// Note how you don't need to specify all endpoints for typings here. The "fetchBooks" is inferred
interface EndpointsList {
fetchBook: Endpoint<Book, BookQueryParams, BookPathParams>;
}
const api = createApiFetcher<EndpointsList, typeof endpoints>({
apiUrl: 'https://example.com/api/',
endpoints,
});
// Fetch book
const book = await api.fetchBook({ newBook: true }, { bookId: 1 });
// Will return an error since "rating" does not exist in "BookQueryParams"
const _book = await api.fetchBook({ rating: 5 });
// You can also pass generic type directly to the request
const books = await api.fetchBooks<Books>();
Check examples.ts file for more examples of usage.
Here’s an example of configuring and using the createApiFetcher()
with all available settings.
const api = createApiFetcher({
baseURL: 'https://api.example.com/',
retry: retryConfig,
endpoints: {
getBooks: {
url: 'books/all',
},
},
fetcher: require('axios'), // Use Axios for requests. If you pass Axios, you can also add all its settings here.
strategy: 'reject', // Error handling strategy.
cancellable: false, // If true, cancels previous requests to same endpoint.
rejectCancelled: false, // Reject promise for cancelled requests.
flattenResponse: false, // If true, flatten nested response data.
defaultResponse: null, // Default response when there is no data or endpoint fails.
timeout: 30000, // Request timeout in milliseconds.
method: 'get', // Default request method.
onError(error) {
// Interceptor on error
console.error('Request failed', error);
},
async onRequest(config) {
// Interceptor on each request
console.error('Fired on each request', config);
return config;
},
async onResponse(response) {
// Interceptor on each response
console.error('Fired on each response', response);
return response;
},
logger: {
// Custom logger for logging errors.
error(...args) {
console.log('My custom error log', ...args);
},
warn(...args) {
console.log('My custom warning log', ...args);
},
},
retry: {
retries: 3, // Number of retries on failure.
delay: 1000, // Initial delay between retries in milliseconds.
backoff: 1.5, // Backoff factor for retry delay.
maxDelay: 30000, // Maximum delay between retries in milliseconds.
retryOn: [408, 409, 425, 429, 500, 502, 503, 504], // HTTP status codes to retry on.
shouldRetry: async (error, attempts) => {
// Custom retry logic.
return (
attempts < 3 &&
[408, 500, 502, 503, 504].includes(error.response.status)
);
},
},
});
try {
// The same API config as used above, except the "endpoints" and "fetcher" and fetcher could be used as 3rd argument of the api.getBooks()
const { data } = await api.getBooks();
console.log('Request succeeded:', data);
} catch (error) {
console.error('Request ultimately failed:', error);
}
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api/v1',
endpoints: {
sendMessage: {
method: 'post',
url: '/send-message/:postId',
},
getMessage: {
url: '/get-message/',
// Change baseURL to external for this endpoint onyl
baseURL: 'https://externalprovider.com/api/v2',
},
},
});
async function sendAndGetMessage() {
await api.sendMessage({ message: 'Text' }, { postId: 1 });
const { data } = await api.getMessage({ postId: 1 });
}
sendAndGetMessage();
Here’s an example of configuring and using the createApiFetcher()
with the retry mechanism:
const retryConfig = {
retries: 3,
delay: 100,
maxDelay: 5000,
backoff: 1.5,
retryOn: [500, 503],
shouldRetry(error, attempt) {
// Retry on specific errors or based on custom logic
return attempt < 3; // Retry up to 3 times
},
};
const api = createApiFetcher({
baseURL: 'https://api.example.com/',
retry: retryConfig,
endpoints: {
getBooks: {
url: 'books/all',
},
},
onError(error) {
console.error('Request failed:', error);
},
});
try {
const { data } = await api.getBooks();
console.log('Request succeeded:', data);
} catch (error) {
console.error('Request ultimately failed:', error);
}
import axios from 'axios';
import { createApiFetcher } from 'axios-multi-api';
const endpoints = {
getPosts: {
url: '/posts/:subject',
},
getUser: {
// Generally there is no need to specify method: 'get' for GET requests as it is default one. It can be adjusted using global "method" setting
method: 'get',
url: '/user-details',
},
updateUserDetails: {
method: 'post',
url: '/user-details/update/:userId',
strategy: 'defaultResponse',
},
};
interface EndpointsList {
getPosts: Endpoint<PostsResponse, PostsQueryParams, PostsPathParams>;
}
const api = createApiFetcher<EndpointsList, typeof endpoints>({
apiUrl: 'https://example.com/api',
fetcher: axios,
endpoints,
onError(error) {
console.log('Request failed', error);
},
headers: {
'my-auth-key': 'example-auth-key-32rjjfa',
},
// Optional: Whole Axios config is supported here
});
// Fetch user data - "data" will return data directly
// GET to: http://example.com/api/user-details?userId=1&ratings[]=1&ratings[]=2
const { data } = await api.getUser({ userId: 1, ratings: [1, 2] });
// Fetch posts - "data" will return data directly
// GET to: http://example.com/api/posts/myTestSubject?additionalInfo=something
const { data } = await api.getPosts(
{ additionalInfo: 'something' },
{ subject: 'test' },
);
// Send POST request to update userId "1"
await api.updateUserDetails({ name: 'Mark' }, { userId: 1 });
// Send POST request to update array of user ratings for userId "1"
await api.updateUserDetails({ name: 'Mark', ratings: [1, 2] }, { userId: 1 });
In the example above we fetch data from an API for user with an ID of 1. We also make a GET request to fetch some posts, update user's name to Mark. If you want to use more strict typings, please check TypeScript Usage section below.
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
endpoints: {
sendMessage: {
method: 'post',
url: '/send-message/:postId',
},
},
});
async function sendMessage() {
try {
await api.sendMessage({ message: 'Text' }, { postId: 1 });
console.log('Message sent successfully');
} catch (error) {
console.log(error);
}
}
sendMessage();
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
strategy: 'softFail',
endpoints: {
sendMessage: {
method: 'post',
url: '/send-message/:postId',
},
},
});
async function sendMessage() {
const { data, error } = await api.sendMessage(
{ message: 'Text' },
{ postId: 1 },
);
if (error) {
console.error('Request Error', error);
} else {
console.log('Message sent successfully');
}
}
sendMessage();
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
endpoints: {
sendMessage: {
method: 'post',
url: '/send-message/:postId',
// You can also specify strategy and other settings in global list of endpoints, but just for this endpoint
// strategy: 'defaultResponse',
},
},
});
async function sendMessage() {
const { data } = await api.sendMessage(
{ message: 'Text' },
{ postId: 1 },
{
strategy: 'defaultResponse',
// null is a default setting, you can change it to empty {} or anything
// defaultResponse: null,
onError(error) {
// Callback is still triggered here
console.log(error);
},
},
);
if (data === null) {
// Because of the strategy, if API call fails, it will just return null
return;
}
// You can do something with the response here
console.log('Message sent successfully');
}
sendMessage();
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
endpoints: {
sendMessage: {
method: 'post',
url: '/send-message/:postId',
// You can also specify strategy and other settings in global list of endpoints, but just for this endpoint
// strategy: 'silent',
},
},
});
async function sendMessage() {
await api.sendMessage(
{ message: 'Text' },
{ postId: 1 },
{
strategy: 'silent',
onError(error) {
console.log(error);
},
},
);
// Because of the strategy, if API call fails, it will never reach this point. Otherwise try/catch would need to be required.
console.log('Message sent successfully');
}
// Note that since strategy is "silent" and sendMessage should not be awaited anywhere
sendMessage();
import axios from 'axios';
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
fetcher: axios,
apiUrl: 'https://example.com/api',
endpoints: {
sendMessage: {
method: 'post',
url: '/send-message/:postId',
},
},
});
async function sendMessage() {
await api.sendMessage(
{ message: 'Text' },
{ postId: 1 },
{
onError(error) {
if (error.response) {
// The request was made and the server responded with a status code
// that falls out of the range of 2xx
console.log(error.response.data);
console.log(error.response.status);
console.log(error.response.headers);
} else if (error.request) {
// The request was made but no response was received
// `error.request` is an instance of XMLHttpRequest in the browser and an instance of
// http.ClientRequest in node.js
console.log(error.request);
} else {
// Something happened in setting up the request that triggered an Error
console.log('Error', error.message);
}
console.log(error.config);
},
},
);
console.log('Message sent successfully');
}
sendMessage();
import { fetchf } from 'axios-multi-api';
const { data } = await fetchf('/api/user-details', {
retry: { retries: 3, delay: 2000 },
});
// src/api.ts
import { createApiFetcher } from 'axios-multi-api';
const api = createApiFetcher({
apiUrl: 'https://example.com/api',
strategy: 'softFail',
endpoints: {
getProfile: { url: '/profile/:id' },
},
});
export default api;
// src/composables/useProfile.ts
import { ref, onMounted } from 'vue';
import api from '../api';
export function useProfile(id: number) {
const profile = ref(null);
const isLoading = ref(true);
const isError = ref(null);
const fetchProfile = async () => {
const { data, error } = await api.getProfile({ id });
if (error) isError.value = error;
else if (data) profile.value = data;
isLoading.value = false;
};
onMounted(fetchProfile);
return { profile, isLoading, isError };
}
<!-- src/components/Profile.vue -->
<template>
<div>
<h1>Profile</h1>
<div v-if="isLoading">Loading...</div>
<div v-if="isError">Error: {{ isError.message }}</div>
<div v-if="profile">
<p>Name: {{ profile.name }}</p>
<p>Email: {{ profile.email }}</p>
</div>
</div>
</template>
<script lang="ts">
import { defineComponent } from 'vue';
import { useProfile } from '../composables/useProfile';
export default defineComponent({
props: { id: Number },
setup(props) {
return useProfile(props.id);
},
});
</script>
If you have any idea for an improvement, please file an issue. Feel free to make a PR if you are willing to collaborate on the project. Thank you :)