Axios setup and configuration in Vue

Introduction

Axios helps you talk to servers easily from your Vue app. Setting it up right makes your app get data smoothly.

You want to get data from a website or API in your Vue app.

You need to send information like forms or login details to a server.

You want to handle errors or loading states when fetching data.

You want to set a base URL so you don't repeat it in every request.

You want to add headers like tokens for secure requests.

Syntax

Vue

import axios from 'axios';

const apiClient = axios.create({
  baseURL: 'https://api.example.com',
  timeout: 10000,
  headers: { 'Content-Type': 'application/json' }
});

Use axios.create() to make a custom instance with your settings.

Set baseURL to avoid typing full URLs every time.

Examples

This sets a base URL for all requests made with api.

Vue

import axios from 'axios';

// Basic setup with base URL
const api = axios.create({
  baseURL: 'https://api.example.com'
});

Adds a timeout so requests stop if they take longer than 5 seconds.

Vue

const api = axios.create({
  baseURL: 'https://api.example.com',
  timeout: 5000
});

Sets a header for all requests, useful for login tokens.

Vue

const api = axios.create({
  headers: { 'Authorization': 'Bearer mytoken123' }
});

Sample Program

This Vue component uses Axios to get posts from a public API when it loads. It shows loading text, errors, or the list of posts.

Vue

<script setup>
import { ref, onMounted } from 'vue';
import axios from 'axios';

const apiClient = axios.create({
  baseURL: 'https://jsonplaceholder.typicode.com',
  timeout: 8000,
  headers: { 'Content-Type': 'application/json' }
});

const posts = ref([]);
const error = ref(null);
const loading = ref(true);

onMounted(async () => {
  try {
    const response = await apiClient.get('/posts');
    posts.value = response.data;
  } catch (err) {
    error.value = 'Failed to load posts';
  } finally {
    loading.value = false;
  }
});
</script>

<template>
  <main>
    <h1>Posts</h1>
    <p v-if="loading">Loading posts...</p>
    <p v-if="error" role="alert" style="color: red">{{ error }}</p>
    <ul v-if="!loading && !error">
      <li v-for="post in posts" :key="post.id">
        <strong>{{ post.title }}</strong><br />
        {{ post.body }}
      </li>
    </ul>
  </main>
</template>

Important Notes

Always handle errors to avoid your app crashing if the server is down.

Use timeout to stop waiting too long for a response.

Set headers like Authorization for secure APIs.

Summary

Axios setup uses axios.create() to make a reusable client.

Set baseURL, timeout, and headers to customize requests.

Use the client in Vue lifecycle hooks to fetch data and update the UI.

Practice

1. What is the main purpose of using axios.create() in a Vue project?

easy

A. To convert Axios requests into Vue components

B. To automatically fetch data when the component mounts

C. To create a reusable Axios client with custom settings

D. To replace Vue's reactive system with Axios

Solution

1. Step 1: Understand axios.create()

   This method creates a new Axios instance that can have its own configuration like baseURL, headers, and timeout.

2. Step 2: Purpose in Vue projects

   Using axios.create() helps keep your API calls consistent and reusable across components by sharing the same settings.

3. Final Answer:

   To create a reusable Axios client with custom settings -> Option C

4. Quick Check:

   axios.create() = reusable client [OK]

Hint: Remember axios.create() makes a custom client [OK]

Common Mistakes:

• Thinking axios.create() fetches data automatically
• Confusing axios.create() with Vue lifecycle hooks
• Assuming axios.create() changes Vue's reactivity

2. Which of the following is the correct way to set a base URL when creating an Axios instance?

easy

A. const api = axios.create('https://api.example.com')

B. const api = axios.create(baseURL = 'https://api.example.com')

C. const api = axios.create({ url: 'https://api.example.com' })

D. const api = axios.create({ baseURL: 'https://api.example.com' })

Solution

1. Step 1: Check axios.create() syntax

   axios.create() accepts an object with configuration keys like baseURL, timeout, and headers.

2. Step 2: Identify correct baseURL usage

   The correct key for setting the base URL is baseURL inside the config object.

3. Final Answer:

   const api = axios.create({ baseURL: 'https://api.example.com' }) -> Option D

4. Quick Check:

   baseURL inside object = const api = axios.create({ baseURL: 'https://api.example.com' }) [OK]

Hint: Use an object with baseURL key inside axios.create() [OK]

Common Mistakes:

• Passing baseURL as a separate argument
• Using url instead of baseURL
• Passing a string directly without an object

3. Given this Axios instance setup in a Vue component:

const api = axios.create({ baseURL: 'https://api.example.com', timeout: 1000 });

api.get('/users')
  .then(response => console.log(response.data))
  .catch(error => console.log('Error:', error.message));

What will happen if the server takes 2 seconds to respond?

medium

A. The request will timeout and log an error message

B. The request will succeed and log the user data

C. The request will retry automatically until success

D. The request will hang indefinitely without error

Solution

1. Step 1: Understand timeout setting

   The timeout is set to 1000 milliseconds (1 second), so if the server takes longer, Axios will abort the request.

2. Step 2: Effect on slow response

   Since the server takes 2 seconds, which is longer than 1 second, Axios triggers a timeout error and the catch block runs.

3. Final Answer:

   The request will timeout and log an error message -> Option A

4. Quick Check:

   Timeout 1s > 2s response = error [OK]

Hint: Timeout shorter than response time causes error [OK]

Common Mistakes:

• Assuming Axios retries automatically
• Thinking the request will succeed despite timeout
• Ignoring the catch block handling

4. Identify the error in this Axios setup code inside a Vue component:

const api = axios.create({
  baseURL: 'https://api.example.com',
  timeout: '5000',
  headers: { 'Content-Type': 'application/json' }
});

medium

A. timeout should be a number, not a string

B. baseURL must be inside headers object

C. Content-Type header is invalid here

D. axios.create() cannot have headers property

Solution

1. Step 1: Check timeout data type

   Timeout expects a number representing milliseconds, but here it is a string '5000'.

2. Step 2: Validate other properties

   baseURL is correctly placed, and headers with Content-Type is valid for axios.create().

3. Final Answer:

   timeout should be a number, not a string -> Option A

4. Quick Check:

   timeout must be number, not string [OK]

Hint: Timeout must be numeric, not quoted string [OK]

Common Mistakes:

• Putting baseURL inside headers
• Removing headers property
• Using string for timeout value

5. You want to create an Axios instance in Vue that automatically adds an Authorization header with a token stored in localStorage for every request. Which setup is correct?

hard

A. const api = axios.create({ baseURL: 'https://api.example.com' }); api.defaults.headers.common['Authorization'] = `Bearer ${localStorage.getItem('token')}`;

B. const api = axios.create({ baseURL: 'https://api.example.com' }); api.interceptors.request.use(config => { config.headers.Authorization = `Bearer ${localStorage.getItem('token')}`; return config; });

C. const api = axios.create({ baseURL: 'https://api.example.com', headers: { Authorization: `Bearer ${localStorage.getItem('token')}` } });

D. const api = axios.create({ baseURL: 'https://api.example.com', headers: { Authorization: localStorage.token } });

Solution

1. Step 1: Understand token dynamic retrieval

   The token in localStorage can change, so it should be read fresh before each request, not just once at setup.

2. Step 2: Use Axios interceptor for dynamic headers

   Using an interceptor lets you add or update headers before every request, ensuring the latest token is used.

3. Step 3: Evaluate options

   const api = axios.create({ baseURL: 'https://api.example.com' }); api.interceptors.request.use(config => { config.headers.Authorization = `Bearer ${localStorage.getItem('token')}`; return config; }); uses an interceptor to set Authorization header dynamically. Options A and C set it once at creation, which may become stale. const api = axios.create({ baseURL: 'https://api.example.com', headers: { Authorization: localStorage.token } }); uses incorrect localStorage access.

4. Final Answer:

   Use an interceptor to add Authorization header dynamically before each request -> Option B

5. Quick Check:

   Interceptor for dynamic token = const api = axios.create({ baseURL: 'https://api.example.com' }); api.interceptors.request.use(config => { config.headers.Authorization = `Bearer ${localStorage.getItem('token')}`; return config; }); [OK]

Hint: Use request interceptor to add fresh token each time [OK]

Common Mistakes:

• Setting headers once at creation, ignoring token updates
• Accessing localStorage.token instead of getItem()
• Not returning config in interceptor