How to structure api calls in Vue.js? How to structure api calls in Vue.js? vue.js vue.js

How to structure api calls in Vue.js?


I am using axios as HTTP client for making api calls, I have created a gateways folder in my src folder and I have put files for each backend, creating axios instances, like following

myApi.js

import axios from 'axios'export default axios.create({  baseURL: 'http://localhost:3000/api/v1',  timeout: 5000,  headers: {    'X-Auth-Token': 'f2b6637ddf355a476918940289c0be016a4fe99e3b69c83d',    'Content-Type': 'application/json'  }})

Now in your component, You can have a function which will fetch data from the api like following:

methods: { getProducts () {     myApi.get('products?id=' + prodId).then(response =>  this.product = response.data)  }}

Similarly you can use this to get data for your vuex store as well.

Edited

If you are maintaining product related data in a dedicate vuex module, you can dispatch an action from the method in component, which will internally call the backend API and populate data in the store, code will look something like following:

Code in component:

methods: { getProducts (prodId) {     this.$store.dispatch('FETCH_PRODUCTS', prodId)  }}

Code in vuex store:

import myApi from '../../gateways/my-api'const state = {  products: []}const actions = {  FETCH_PRODUCTS: (state, prodId) => {    myApi.get('products?id=' + prodId).then(response => state.commit('SET_PRODUCTS', response))  }} // mutationsconst mutations = {  SET_PRODUCTS: (state, data) => {    state.products = Object.assign({}, response.data)  }}const getters = {}export default {  state,  mutations,  actions,  getters}


Note: vue-resource is retired ! Use something else, such as Axios.

I'm using mostly Vue Resource.I create services directory, and there put all connections to endpoints, for e.g PostService.js

import Vue from 'vue'export default {  get(id) {    return Vue.http.get(`/api/post/${id}`)  },  create() {    return Vue.http.post('/api/posts')   }  // etc}

Then in my file I'm importing that service and create method that would call method from service file

SomeView.vue

import PostService from '../services/PostService'export default {  data() {    item: []  },  created() {    this.fetchItem()  },  methods: {    fetchItem() {      return PostService.get(to.params.id)        .then(result => {          this.item = result.json()        })    }    }}


Based on concept of Belmin Bedak`s answer, i have wrapped it all into a simple library:

https://github.com/robsontenorio/vue-api-query

You can request your API like this:

All results

// GET /posts?filter[status]=ACTIVElet post = await Post  .where('status', 'ACTIVE')  .get()

Specific result

// GET /posts/1let post = await Post.find(1)

Editing

// PUT /posts/1 post.title = 'Awsome!'post.save()

Relationships

// GET /users/1let user = await User.find(1)// GET users/1/postslet posts = await user  .posts()  .get()