Vue Axios Js

Posted on  by admin

You’re browsing the documentation for v2.x and earlier. For v3.x, click here. There are many times when building application for the web that you may want to consume and display data from an API.

Base Example

There are several ways to do so, but a very popular approach is to use axios, a promise-based HTTP client. In this exercise, we’ll use the CoinDesk API to walk through displaying Bitcoin prices, updated every minute.

First, we’d install axios with either npm/yarn or through a CDN link.

Introduction to Vue.js Axios

There are a number of ways we can request information from the API, but it’s nice to first find out what the shape of the data looks like, in order to know what to display.

In order to do so, we’ll make a call to the API endpoint and output it so we can see it.

We can see in the CoinDesk API documentation, that this call will be made to https://api.coindesk.com/v1/bpi/currentprice.json.

So first, we’ll create a data property that will eventually house our information, and we’ll retrieve the data and assign it using the mounted lifecycle hook:.

And what we get is this:. See the Pen First Step Axios and Vue by Vue (@Vue) on CodePen.

We’ve got some data. But it looks pretty messy right now so let’s display it properly and add some error handling in case things aren’t working as expected or it takes longer than we thought to get the information.

Vue Login Form

It’s pretty typical that the information we’ll need is within the response, and we’ll have to traverse what we’ve just stored to access it properly.

In our case, we can see that the price information we need lives in response.data.bpi.

If we use this instead, our output is as follows:.

Real-World Example: Working with the Data

See the Pen Second Step Axios and Vue by Vue (@Vue) on CodePen. This is a lot easier for us to display, so we can now update our HTML to display only the information we need from the data we’ve received, and we’ll create a filter to make sure that the decimal is in the appropriate place as well.

With Server-Side Rendering

See the Pen Third Step Axios and Vue by Vue (@Vue) on CodePen. There are times when we might not get the data we need from the API.

There are several reasons that our axios call might fail, including but not limited to:. The API is down. The request was made incorrectly. The API isn’t giving us the information in the format that we anticipated.

When making this request, we should be checking for just such circumstances, and giving ourselves information in every case so we know how to handle the problem.

In an axios call, we’ll do so by using catch. This will let us know if something failed during the API request, but what if the data is mangled or the API is down?

Right now the user will just see nothing. We might want to build a loader for this case, and then tell the user if we’re not able to get the data at all.

You can hit the rerun button on this pen to see the loading status briefly while we gather data from the API:. See the Pen Fourth Step Axios and Vue by Vue (@Vue) on CodePen.

Displaying Response Data

This can be even further improved with the use of components for different sections and more distinct error reporting, depending on the API you’re using and the complexity of your application.

The Fetch API is a powerful native API for these types of requests. You may have heard that one of the benefits of the Fetch API is that you don’t need to load an external resource in order to use it, which is true! Except… that it’s not fully supported yet, so you will still need to use a polyfill.

There are also some gotchas when working with this API, which is why many prefer to use axios for now. This may very well change in the future though.

If you’re interested in using the Fetch API, there are some very good articles explaining how to do so.

Wrapping Up

There are many ways to work with Vue and axios beyond consuming and displaying an API. You can also communicate with Serverless Functions, post/edit/delete from an API where you have write access, and many other benefits.

Due to the straightforward integration of these two libraries, it’s become a very common choice for developers who need to integrate HTTP clients into their workflow.

Caught a mistake or want to contribute to the documentation?Edit this on GitHub!Deployed onNetlify .

Vue doesn't have a built-in HTTP request library. The official Vue cookbook recommends using Axios to interact with REST APIs.

This tutorial will use the excellent JSONPlaceholder API to provide sample data.

For example, if youtype https://jsonplaceholder.typicode.com/users/1 in your browser's URL bar, you'llget the below response:. The axios.get() function executesan HTTP GET and returns a promise. So calling await axios.get('https://jsonplaceholder.typicode.com') gets you an object whose data property containsthe above JSON data. Remember that Vue hooks can be async functions. So that means you can use async/await to execute the Axios request.

More Vue Tutorials

Unfortunately, the above example as written won't work with Vue server-side rendering because:. Vue's renderToString() doesn't call mounted hooks, because the component is never actually mounted.

Vue's renderToString() doesn't wait for async hooks to execute, so even if you used created, the above example wouldn't work. However, there is an easy workaround. Just call the mounted() function manuallyand await on it.

Alternative Patterns

Vue School has some of our favorite Vue video courses. Their Vue.js Master Class walks you through building a real world application, and does a great job of teaching you how to integrate Vue with Firebase.

Vue.js Axios is defined as an HTTP client request for the node and the browser.

Setup with Axios

Axios can be done with simple JavaScript or React and Vue. Axios is an Excellent HTTP library that executes on both client and a server, which makes an API request, does the task to produce the result and specifies easier concepts to read and debug.

Vue.js is the front-end JavaScript Framework to build tools and libraries.