VUE3 Getting Started Tutorial: Using the Vue.js plug-in to encapsulate API interface requests

Vue.js is one of the more popular front-end frameworks currently. Vue3 is the latest version of Vue.js, which provides simpler syntax and better performance. In the development of Vue.js, data requests are an essential part, and API interface requests are also one of the common tasks of programmers. This tutorial will introduce in detail how to use the Vue.js plug-in to encapsulate API interface requests.

What is Vue.js plug-in?

In Vue.js, a plug-in is a functional module that can provide global-level functions for Vue.js applications. We can encapsulate functionality in plugins and inject properties, directives, components, and more into Vue.js applications. Vue.js officially provides some common plug-ins for us to use, such as Vue Router and Vuex. Of course, we can also write our own plug-ins to achieve the functions we need.

1. Creating plug-ins

We can create simple plug-ins by defining global functions or properties. But in this tutorial, we will introduce how to encapsulate API interface requests in a plug-in. First, we need to install axios, which is a popular JavaScript library for handling HTTP requests.

npm install axios --save

Then, we create an API plugin as follows:

import axios from 'axios'

const ApiPlugin = {
install(Vue) {

Vue.prototype.$api = {
  get(url) {
    return axios.get(url)
  },
  post(url, data) {
    return axios.post(url, data)
  }
}

}
}

export default ApiPlugin

In the above code, we define an ApiPlugin plug-in, It contains an install() method that accepts the Vue constructor as a parameter. A $api attribute is defined in the install() method, and an object containing two methods (get and post) is attached to Vue.prototype.

2. Using Plugins

Now that we have created an API plugin, we need to use it in our Vue.js application. We can use the following code to introduce the plugin into the Vue.js application:

import Vue from 'vue'
import App from './App.vue'
import ApiPlugin from './ api-plugin'

Vue.use(ApiPlugin)

new Vue({
render: h => h(App),
}).$mount(' #app')

In the above code, we first introduce the ApiPlugin into the application through the import statement, and then use the Vue.use() method to install the plug-in. Finally, we create a Vue instance and mount it on the #app element. Now, we can use the $api attribute to make API requests in our application.

3. Send API request

Suppose we want to send a GET request and get the returned data. We can use the $api.get() method in the Vue component to achieve this:

d477f9ce7bf77f53fbcf36bec1b69b7a
dc6dce4a544fdca2df29d5ac0ea9906b

<h1>{{ message }}</h1>

16b28748ea4df4d9c2150843fecfba68
< ;/template>

3f1c4e4b6b16bbbd69b2ee476dc4f83a
export default {
name: 'App',
data() {

return {
  message: '',
}

},
async mounted () {

const response = await this.$api.get('http://localhost:3000')
this.message = response.data.message

}
}
2cacc6d41bbb37262a98f745aa00fbf0

In the above code, we use the $api.get() method in the mounted hook function to request http Send a GET request to ://localhost:3000 and assign the returned data to the message attribute after the request is completed to display it in the template.

4. Send a POST request

Sending a POST request is similar to sending a GET request, just pass the data as the second parameter of the $api.post() method ：

async submit() {
const data = { name: 'John', age: 30 }
const response = await this.$api.post('http://localhost: 3000', data)
console.log(response.data)
}

In the above code, we created a data object containing two attributes in the submit() method. Pass it as the second parameter when calling the $api.post() method. We print the returned data to the console.

Summary

By studying this tutorial, you should now understand how to use the Vue.js plug-in to encapsulate API interface requests. In actual development, API requests are usually used together with other functions, components, etc. We can better organize and reuse code by creating appropriate plug-ins. I hope this tutorial can help you with your Vue.js development work.

The above is the detailed content of VUE3 Getting Started Tutorial: Using the Vue.js plug-in to encapsulate API interface requests. For more information, please follow other related articles on the PHP Chinese website!