@borngroup/lightswitch-boilerplate-api v0.1.29

#API-Client

Overview

The "api-client" package is the server layer that extends the vue-storefront / Born Lightswitch Server Middleware.

The package is intended to create new endpoints that will handle the http requests, accept parameters sent from the frontend, and then use them to fetch or submit data to the platform.

The custom client will acts as a proxy between the users and the platform.

Types of custom api-clients

###GraphQL

• Apollo ###Plain http
• Axios

##api-client vs Composables To provide customizable and easy to maintain applications, Vue Storefront offers composables.

Composables are the main public API of Vue Storefront and in many cases the only API you'll work with.

They are functions that implement most of the business logic of the application. You can treat each composable as an independent micro-application.

##Accessing Platform APIs

Extending GraphQL via Nuxt

Quick Reference Notes

• In Vue-Storefront / Lightswitch single integration has its own sort of software development kit (SDK) library. This library is named API-client and contains a set of functions

• Each function is dedicated to one action, endpoint or a feature eg. getProduct, loadCart addToCart

• Each custom query lives in the middleware.config.js, so it's the place where we should define my-products-query.

• Every custom query is registered in the middleware.config.js file:

###Documentation

• vue-storefront integration guide
• Calling Platform API
• Extending GraphQL