# How to use

This page shows an simple example how to setup and use vuex-rest-api.

# Steps

  1. Import vuex-rest-api (I called it Vapi).
  2. Create a Vapi instance.
    At least you have to set the base URL of the API you're requesting from. You can also define the default state. If you don't define a default state from a property it will default to null. In the example
  3. Create the actions.
    Each action represents a Vuex action. If it will be called (property action), it requests a specific API endpoint (property path) and sets the related property named property to the response's payload.
  4. Create the store object
  5. Pass it to Vuex. Continue reading here to know how to call the actions.
// store.js

import Vuex from "vuex"
import Vue from "vue"
// Step 1
import Vapi from "vuex-rest-api"


// Step 2
const posts = new Vapi({
  baseURL: "https://jsonplaceholder.typicode.com",
    state: {
      posts: []
  // Step 3
    action: "getPost",
    property: "post",
    path: ({ id }) => `/posts/${id}`
    action: "listPosts",
    property: "posts",
    path: "/posts"
    action: "updatePost",
    property: "post",
    path: ({ id }) => `/posts/${id}`
  // Step 4

// Step 5
export const store = new Vuex.Store(posts)
Last Updated: 10/25/2018, 10:31:55 PM