Merge pull request #370 from shivendra-webkul/rest-api

Added rest API page in 2.x

docs/.vuepress/version-configs/2.x.js

@@ -97,5 +97,13 @@ module.exports = [
             ['themes/notification', 'Real Time Notification'],
             ['themes/integrate-image-search-in-theme', 'Image Search']
         ])
-    }
+    },
+    {
+        title: 'Bagisto APIs',
+        path: setVersionPrefix('api'),
+        collapsable: true,
+        children: setVersionPrefix([
+            ['api/getting-started-with-the-api', 'Rest API'],
+        ])
+    },
 ]

docs/2.x/api/README.md

@@ -0,0 +1,7 @@
+# Bagisto APIs
+
+[[toc]]
+
+## REST API
+
+The Bagisto REST API supports REST (Representational State Transfer) and provides access to CRUD (Create, Read, Update, Delete) operations. It also supports pagination to increase the performance of the application. The Bagisto REST API can be used to build a PWA (Progressive Web Application) application, integrate an online shopping mobile application with the Bagisto store.

docs/2.x/api/getting-started-with-the-api.md

@@ -0,0 +1,98 @@
+# Bagisto APIs
+
+[[toc]]
+
+## REST API
+
+Bagisto REST API is a medium to use the features of the core Bagisto System. By using Bagisto REST API, you can integrate your application to serve the default content of Bagisto.
+
+## Explore REST API Demo
+
+Welcome to our API demo! Dive into the interactive showcase of our API functionalities to get a hands-on experience of how our platform works. Click the Link below to access the demo:
+
+[Access API Demo](https://demo.bagisto.com/bagisto-api-demo-common)
+
+#### Click the Link below to access Admin OR Shop API documentation 
+
+[Admin](https://demo.bagisto.com/bagisto-api-demo-common/api/admin/documentation)
+
+[Shop](https://demo.bagisto.com/bagisto-api-demo-common/api/shop/documentation)
+
+
+#### Installation of REST API
+
+To install Bagisto REST API, you need to follow some steps.
+
+- To install Bagisto REST API from your console:
+
+~~~
+composer require bagisto/rest-api dev-master
+~~~
+
+- Add below options in the .env file (i.e. http://localhost/public your domain):
+
+~~~
+SANCTUM_STATEFUL_DOMAINS=http://localhost/public
+~~~
+
+- To configure the REST API L5-Swagger Documentation run below command:
+
+~~~
+php artisan bagisto-rest-api:install
+~~~
+
+- To check the Admin end API documentation:
+
+~~~
+http://localhost/public/api/admin/documentation
+~~~
+
+- To check the Shop end API documentation:
+
+~~~
+http://localhost/public/api/shop/documentation
+~~~
+
+* You can check the <a href="https://github.com/DarkaOnLine/L5-Swagger"> L5-Swagger </a> guidelines too regarding the configuration the API documentation.
+
+-  For admin login
+
+* To add Laravel Sanctum's API token to the Admin model follow the given path.
+
+~~~
+packages/Webkul/User/src/Models/Admin.php
+~~~
+
+~~~php
+<?php
+namespace Webkul\User\Models;
+
+use Laravel\Sanctum\HasApiTokens;
+
+class Admin extends Authenticatable implements AdminContract
+{
+    use HasApiTokens;
+    ...
+}
+~~~
+
+-  For customer login
+
+* To add Laravel Sanctum's API token to the customer model follow the given path.
+
+~~~
+packages/Webkul/Customer/src/Models/Customer.php
+~~~
+
+~~~php
+<?php
+namespace Webkul\Customer\Models;
+
+use Laravel\Sanctum\HasApiTokens;
+
+class Customer extends Authenticatable implements CustomerContract
+{
+    use HasApiTokens;
+    ...
+}
+~~~