mirror of https://github.com/axios/axios.git synced 2026-04-11 14:21:59 +08:00

* ci: set hardened --ignore-scripts for all ci actions

* docs: adds new docs platform

* chore: remove un-needed ignore

* chore: add sponsors data. adjust package.json to be of type module

* fix: inconsistency between the docs and readme

* fix: docs inconsistency

* docs: update language and phrasing

* style: fix issues with card styling

* docs: update security.md with latest changes

* docs: remove un-needed code

* docs: fix inconsistencies with actual library function

* ci: added deployment for docs

* chore: added axios as dep for docs

* docs: fix batch of errors

* fix: bump esbuild as the version included is a risk

2026-04-04 20:25:41 +02:00

2.6 KiB

Raw Blame History

Creating an instance

axios.create() lets you create a pre-configured axios instance. The instance shares the same request and response API as the default axios object, but uses the config you provide as its baseline for every request. This is the recommended way to use axios in any application larger than a single file.

import axios from "axios";

const instance = axios.create({
  baseURL: "https://api.example.com",
  timeout: 5000,
  headers: { "X-Custom-Header": "foobar" },
});

The create method accepts the full Request Config object. You can then use the instance just like the default axios object:

const response = await instance.get("/users/1");

Why use an instance?

Per-service base URL

In most apps you talk to more than one API. Creating a separate instance per service avoids repeating the base URL on every call:

const githubApi = axios.create({ baseURL: "https://api.github.com" });
const internalApi = axios.create({ baseURL: "https://api.internal.example.com" });

const { data: repos } = await githubApi.get("/users/axios/repos");
const { data: users } = await internalApi.get("/users");

Shared authentication headers

Attach an auth token to every request from one instance without touching others:

const authApi = axios.create({
  baseURL: "https://api.example.com",
  headers: {
    Authorization: `Bearer ${getToken()}`,
  },
});

Per-service timeouts and retries

Different services have different reliability characteristics. Set a tight timeout for real-time services and a relaxed one for batch jobs:

const realtimeApi = axios.create({ baseURL: "https://realtime.example.com", timeout: 2000 });
const batchApi    = axios.create({ baseURL: "https://batch.example.com",    timeout: 60000 });

Isolated interceptors

Interceptors added to an instance only apply to that instance, keeping your concerns separate:

const loggingApi = axios.create({ baseURL: "https://api.example.com" });

loggingApi.interceptors.request.use((config) => {
  console.log(`→ ${config.method?.toUpperCase()} ${config.url}`);
  return config;
});

Overriding defaults per request

Config passed at request time always overrides the instance defaults:

const api = axios.create({ timeout: 5000 });

// This specific request uses a 30-second timeout instead
await api.get("/slow-endpoint", { timeout: 30000 });

::: tip Instance defaults can also be changed after creation by writing to instance.defaults:

instance.defaults.headers.common["Authorization"] = `Bearer ${newToken}`;

:::

2.6 KiB Raw Blame History