Skip to main content

Vue 3 Consume GraphQL Endpoint Using Vue Apollo

In this article, we are going to implement Vue 3 sample application that consumes GrpahQL Endpoint using the Vue Apollo library.

Create Vue 3 Application:

Let's create a sample Vue 3 application to accomplish our demo.
Vue CLI Command To Create Project:
vue create your_project_name

GraphQL Server Endpoint:

We should have a GraphQL server endpoint for our demo. So I created a GraphQL server endpoint using 'Dotnet', so I'm going to use it here so its URL be like 'https://localhost:6001/graphql'. So please make sure to have your own GraphQL server endpoint.

Install Vue Apollo And Its Dependent Libraries:

npm install --save @vue/apollo-option

npm install --save @apollo/client

npm install --save graphql

npm install --save graphql-tag

One more plugin we have to install 'react', at the time of this article written we will get an error that says that need to install the 'react', so this 'react' installation might be avoided in feature releases of '@apollo/client'.
npm install react

Initial ApolloClient Setup:

Let's create a file to set up the ApolloClient like 'apollo.provider.js'.
src/apollo.provider.js:
import { InMemoryCache, ApolloClient } from "@apollo/client";
import { createApolloProvider } from "@vue/apollo-option";

const cache = new InMemoryCache();

const apolloClient = new ApolloClient({
  cache,
  uri: "https://localhost:6001/graphql/",
});

export const provider = createApolloProvider({
  defaultClient: apolloClient,
});
  • (Line: 4) Initialize the 'InMemoryCache' loads from the '@apollo/client'. The reason behind using the 'InMemoryCache' is to store the API response into the cache so that the subsequent request will load the data from the cache instead of calling API again and again.
  • (Line: 6-9) Initialize the 'ApolloClient' load from the '@apollo/client'.Here we have to pass configurations like 'cache' and our Graphql endpoint.
  • (Line: 11-13) Defined the 'createApolloProvider' that loads from the '@vue/apollo-option'.
src/Main.js:
import { createApp } from 'vue'
import App from './App.vue'
import * as apolloProvider from './apollo.provider'

const app = createApp(App)

app.use(apolloProvider.provider);
app.mount('#app');
  • (Line: 3) Imported the 'apolloProvider'.
  • (Line: 7) Integrating 'apolloProvider' into the vue instance.

Query:

The 'Query' to fetch the data from the GraphQL endpoint.
query {
  fetchAllGadgets{
    id,
    productName,
    brand,
    cost,
    type
  }
}
  • Here 'id', 'prodcutName', 'brand', 'cost', 'type' are requested props from the server.

Implement Query:

Let's create a new component like 'components/Home.vue'. So now let's use 'Query' to fetch the data and display it on the bootstrap table.
components/Home.vue(HTML Template Part):
<template>
  <div class="container">
    <div class="row mt-1">
      <table class="table table-bordered">
        <thead>
          <tr>
            <th scope="col">Id</th>
            <th scope="col">Product Name</th>
            <th scope="col">Brand</th>
            <th scope="col">Cost</th>
            <th scope="col">Type</th>
          </tr>
        </thead>
        <tbody>
          <tr v-for="item in fetchAllGadgets" :key="item.id">
            <td>{{ item.id }}</td>
            <td>{{ item.productName }}</td>
            <td>{{ item.brand }}</td>
            <td>{{ item.cost }}</td>
            <td>{{ item.type }}</td>
          </tr>
        </tbody>
      </table>
    </div>
  </div>
</template>
  • Binding the response data to the bootstrap table.
components/Home.vue:(Script Part)
<script>
import gql from "graphql-tag";
export default {
  apollo: {
    fetchAllGadgets: {
      query: gql`
        query {
          fetchAllGadgets {
            id
            productName
            brand
            cost
            type
          }
        }
      `
    },
    
  },
  data() {
    return {
      fetchAllGadgets: []
    };
  }
};
</script>
  • (Line: 4) All 'Queries' have to be defined inside of the 'apollo' property. The 'apollo' is not a vue predefined property it was designed for GraphQL 'Queries.
  • The 'fetchAllGadgets' property at 'Line-5' and 'Line-22' must match with the name of the 'Query' at 'Line-8'. The 'Vue Apollo' library can easily understand the property naming conventions. For suppose if you want to give a different property name at 'Line-5' and 'Line-22' we have to do some explicit implementation.
  • So here property name in 'data()' function and property name 'apollo' object are same(fetchAllGadgets). So whenever we used this property for HTML binding then automatically corresponding 'Query' property in 'apollo' object gets executed automatically GraphQL  Endpoint invoked and fetches the data.
Now run our application and then check the output.

Configure Vue Routing:

Let's create a new component like 'CreateForm.vue'. This component will be used to add new items using 'Mutation' of GraphQL in upcoming steps.
components/CreateForm.vue:
<template>
    <div>Create Form</div>
</template>
<script>
export default {
}
</script>
Now run the below command to install the vue route library.
npm install vue-router@4

Now let's create a new js file like 'appRouter.js', where we have to define all our application routes.
src/appRouter.js:
import { createRouter, createWebHistory } from "vue-router";

import Home from "./components/Home.vue";
import CreateForm from "./components/CreateForm.vue";

const routes = [
  { path: "/", component: Home },
  { path: "/create-form", component: CreateForm }
];

export const router = createRouter({
  history: createWebHistory(),
  routes: routes,
});
Now inject the route into the vue instance.
src/main.js:
import { createApp } from 'vue'
import App from './App.vue'
import * as apolloProvider from './apollo.provider'
import * as routerConfig from './appRouter'

const app = createApp(App)

app.use(apolloProvider.provider);
app.use(routerConfig.router);
app.mount('#app');
  • (Line: 4) Imported the 'appRouter'.
  • (Line: 9) Induced our vue route into the vue instance pipeline. 
Add the bootstrap menu in the 'App.vue' component.
src/App.vue:
<template>
  <nav class="navbar navbar-expand-lg navbar-light bg-primary">
    <div class="container-fluid">
      <div
        class="collapse navbar-collapse text-white"
        id="navbarSupportedContent"
      >
        <ul class="navbar-nav me-auto mb-2 mb-lg-0">
          <li class="nav-item active">
            <router-link to="/" class="nav-link">Home</router-link>
          </li>
          <li class="nav-item">
            <router-link to="/create-form" class="nav-link"
              >Create Form</router-link
            >
          </li>
        </ul>
      </div>
    </div>
  </nav>
  <router-view></router-view>
</template>
Now run the application and check the output.

Understand InMemory Cache Flow:

From the initial steps, we know by default Vue Apollo uses InMemory cache to store all the results of the 'Queries'. So to check it, open browser developer tools and goto network calls and then navigate between the routes at the menu, you can observe only one GraphQL call, but the results will be populated from the cache.

Now if you want to disable cache for any 'Query', we can achieve it by using 'fetchpolicy' value to 'no-cahce'. So now update our 'fetchAllGadgets' object inside of the 'apollo' object as below.
components/Home.vue:
apollo: {
    fetchAllGadgets: {
      query: gql`
        query {
          fetchAllGadgets {
            id
            productName
            brand
            cost
            type
          }
        }
      `,
      fetchPolicy: "no-cache"
    }, 
}
Now if we check network calls every time a component loads GraphQL API calls will be invoked.

Query With Parameters:

So for a query to pass dynamic value we have to use the concept of 'variable'. Using variables we can pass the query params.
Query:
query($brandQuery:String){
  filterByBrand(brand:$brandQuery){
    id,
    productName,
    brand,
    cost,
    type
  }
}
  • Here '$brandQuery' is a variable type whose value will be dynamically replaced by the 'variable' object.
Variable:
{
  "brandQuery":"Samsung"
}
  • So here property name 'brandQuery' inside the variable object must match with '$brandQuery' in the Query.

Implement Query With Parameters:

The previous 'Query' is plain with fetches all data from the server. Now let's update our sample to add a search box on top of our table so that we can use the 'Query' with parameters.
components/Home.vue:(Template Part)
<template>
  <div class="container">
    <div class="container mt-3">
      <form class="d-flex">
        <input
          class="form-control me-2"
          type="search"
          v-model="searchValue"
          placeholder="Search By Brand"
        />
        <button
          class="btn btn-outline-primary"
          v-on:click="searchByBrand"
          type="button"
        >
          Search
        </button>
      </form>
    </div>
    <div class="row mt-1">
      <table class="table table-bordered">
        <thead>
          <tr>
            <th scope="col">Id</th>
            <th scope="col">Product Name</th>
            <th scope="col">Brand</th>
            <th scope="col">Cost</th>
            <th scope="col">Type</th>
          </tr>
        </thead>
        <tbody>
          <tr v-for="item in filterByBrand" :key="item.id">
            <td>{{ item.id }}</td>
            <td>{{ item.productName }}</td>
            <td>{{ item.brand }}</td>
            <td>{{ item.cost }}</td>
            <td>{{ item.type }}</td>
          </tr>
        </tbody>
      </table>
    </div>
  </div>
</template>
  • (Line: 5-10) Added search box and enable model binding with 'searchValue' property.
  • (Line: 11-17) Added search button and register the click event with 'searchByBrand' method.
  • (Line: 32) Updated results property as 'filterByBrand'.
components/Home.vue:(Script Part)
<script>
import gql from "graphql-tag";
export default {
  apollo: {
    filterByBrand: {
      query: gql`
        query ($brandQuery: String) {
          filterByBrand(brand: $brandQuery) {
            id
            productName
            brand
            cost
            type
          }
        }
      `,
      variables() {
        return {
          brandQuery: this.brandQuery,
        };
      },
    },
  },
  data() {
    return {
      filterByBrand: [],
      searchValue: "",
      brandQuery: "",
    };
  },
  methods: {
    searchByBrand() {
      this.brandQuery = this.searchValue;
    },
  },
};
</script>
  • (Line: 5-15) Query with parameters registered inside of the 'apollo' object.
  • (Line: 17-21) Here 'variables()' are registered as a function because the data inside of it changes, then it will automatically invoke API call. So here the data property  'brandQuery' change will invoke the API call. So to achieve reactiveness we have to register 'variables' like functions.
  • (Line: 32-34) Registered 'searchByBrand'. Here if we observe we have created 2 data properties like 'searchValue' and 'brandQuery' reason if we use single property then every key entering in the search bar will trigger the API call.

Mutation:

Mutation operation to save data to the server. So data will be carried out by the GraphQL variable concept.
Mutation:
mutation ($myGadgets:GadgetsInput){
  save(model: $myGadgets){
    id,
    productName,
    brand,
    cost,
    type
  }
}
Variables:
{
  "myGadgets":{
    "productName":"Samsung Galaxy G1000",
    "brand":"Samsung",
    "cost":10000,
    "type":"mobile"
  }
}

Implement Mutation:

Now let's understand the mutation operation to save items to the server. So in our example in 'CreateForm.vue' component let's add a form to submit the new item.
components/CreateForm.vue:(Template Part)
<template>
  <div class="container mt-4">
    <form class="col-lg-6 offset-lg-3">
      <div class="row text-center">
        <h4>Create A Gadget</h4>
      </div>
      <input
        class="form-control mt-2"
        type="text"
        v-model="gadget.productName"
        placeholder="Enter Product Name"
      />
      <input
        class="form-control mt-2"
        type="text"
        v-model="gadget.brand"
        placeholder="Enter Brand"
      />
      <input
        class="form-control mt-2"
        type="number"
        v-model="gadget.cost"
        placeholder="Enter Cost"
      />
      <input
        class="form-control mt-2"
        type="text"
        v-model="gadget.type"
        placeholder="Enter Type"
      />

      <button
        class="btn btn-outline-primary offset-5 mt-2 justify-content-center"
        type="button"
        v-on:click="addGadget"
      >
        Create
      </button>
    </form>
  </div>
</template>
  • Added a small form to post the data to the server.
  • (Line: 35)Button register with an 'addGadget' method.
components/CreateForm.vue:(Script Part)
<script>
import gql from "graphql-tag";
const filterByBrandQuery = gql`
  query ($brandQuery: String) {
    filterByBrand(brand: $brandQuery) {
      id
      productName
      brand
      cost
      type
    }
  }
`;
export default {
  data() {
    return {
      gadget: {
        productName: "",
        brand: "",
        cost: 0,
        type: "",
      },
    };
  },
  methods: {
    addGadget() {
      this.$apollo
        .mutate({
          mutation: gql`
            mutation ($myGadgets: GadgetsInput) {
              save(model: $myGadgets) {
                id
                productName
                brand
                cost
                type
              }
            }
          `,
          variables: {
            myGadgets: this.gadget,
          },
          update: (store, { data: { save } }) => {
            const gadgetsQuery = {
              query: filterByBrandQuery,
              variables: { brandQuery: "" },
            };

            const existingData = Object.assign(
              {},
              store.readQuery(gadgetsQuery)
            );
            const newData = [];
            newData.push(save);
            for (let i = 0; i < existingData.filterByBrand.length; i++) {
              newData.push(existingData.filterByBrand[i]);
            }
            existingData.filterByBrand = newData;
            store.writeQuery({
              query: filterByBrandQuery,
              variables: { brandQuery: "" },
              data: existingData,
            });
          },
        })
        .then((data) => {
          console.log(data);
          this.$router.push("/");
        })
        .catch((error) => {
          console.log(error);
        });
    },
  },
};
</script>
  • (Line: 3-13) Defined our 'Query' with params as constant. This value will be used to update the cache data.
  • (Line: 17-22) The 'gadgets' object is used to model binding for our form.
  • (Line: 27-28) The 'this.$apollo.mutate({})' method provides us by 'Vue Apollo' library.
  • (Line: 29-25) Defined the 'Mutation' to post the data to the server.
  • (Line: 43-63) The 'update' method is to store the newly saved item into the cache.
  • (Line: 43) The 'save' property name must match with the name in 'Mutation' it is like the response object property name.
  • (Line: 45-47) Preparing the 'Query' with parameter.
  • (Line: 49-52) Using our 'Query' fetching all collection of data from the in-memory cache.
  • (Line: 53-58) The latest record was pushed into the collection.
  • (Line: 59-63) Updating the collection into the memory cache using 'store.writeQuery({})'
  • (Line: 68) On the successful response from the sever navigating back to 'Home' component
So that's all about the sample demo on Vue 3 application to consume GraphQL API using the Vue Apollo.

Video Session:

 

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on Vue 3 application to consume GraphQL Endpoint using the Vue Apollo library. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform