updated swagger and added exception handling in couchbase service provider

Update .gitignore to include composer.lock and package-lock.json files.
Fixed Hotel Test and formatted readme liniting

Author: teetangh

.gitignore

@@ -18,3 +18,5 @@ yarn-error.log
 /.fleet
 /.idea
 /.vscode
+composer.lock
+package-lock.json

README.md

@@ -1,26 +1,25 @@
 # Quickstart in Couchbase with PHP using Laravel
 
-#### REST API using Couchbase Capella in PHP using Laravel
+## REST API using Couchbase Capella in PHP using Laravel
 
 Often, the first step developers take after creating their database is to create a REST API that can perform Create, Read, Update, and Delete (CRUD) operations for that database. This repo is designed to teach you and give you a starter project (in PHP using Laravel) to generate such a REST API. After you have installed the travel-sample bucket in your database, you can run this application which is a REST API with Swagger documentation so that you can learn:
 
-1. How to create, read, update, and delete documents using Key-Value[ operations](https://docs.couchbase.com/php-sdk/current/howtos/kv-operations.html) (KV operations). KV operations are unique to Couchbase and provide super fast (think microseconds) queries.
+1. How to create, read, update, and delete documents using Key-Value[operations](https://docs.couchbase.com/php-sdk/current/howtos/kv-operations.html) (KV operations). KV operations are unique to Couchbase and provide super fast (think microseconds) queries.
 2. How to write simple parametrized [N1QL queries](https://docs.couchbase.com/php-sdk/current/howtos/n1ql-queries-with-sdk.html) using the built-in travel-sample bucket.
 
 Full documentation for the tutorial can be found on the [Couchbase Developer Portal](https://developer.couchbase.com/tutorial-quickstart-laravel-php/).
 
-
 ## Prerequisites
 
 To run this prebuilt project, you will need:
 
 - [Couchbase Capella](https://www.couchbase.com/products/capella/) cluster with [travel-sample](https://docs.couchbase.com/php-sdk/current/ref/travel-app-data-model.html) bucket loaded.
-    - To run this tutorial using a self-managed Couchbase cluster, please refer to the [appendix](#running-self-managed-couchbase-cluster).
+  - To run this tutorial using a self-managed Couchbase cluster, please refer to the [appendix](#running-self-managed-couchbase-cluster).
 - [PHP](https://www.php.net/downloads.php) 8.2 or higher installed
-    - Ensure that the PHP version is [compatible](https://docs.couchbase.com/php-sdk/current/project-docs/compatibility.html#php-version-compat) with the Couchbase SDK.
+  - Ensure that the PHP version is [compatible](https://docs.couchbase.com/php-sdk/current/project-docs/compatibility.html#php-version-compat) with the Couchbase SDK.
 - Loading Travel Sample Bucket
-    If travel-sample is not loaded in your Capella cluster, you can load it by following the instructions for your Capella Cluster:
-    - [Load travel-sample bucket in Couchbase Capella](https://docs.couchbase.com/cloud/clusters/data-service/import-data-documents.html#import-sample-data)
+  If travel-sample is not loaded in your Capella cluster, you can load it by following the instructions for your Capella Cluster:
+  - [Load travel-sample bucket in Couchbase Capella](https://docs.couchbase.com/cloud/clusters/data-service/import-data-documents.html#import-sample-data)
 
 ## App Setup
 
@@ -40,7 +39,36 @@ The dependencies for the application are specified in the `composer.json` file i
 composer install
 ```
 
+### Initial Configuration
+
+After installing dependencies, you need to set up the basic Laravel configuration:
+
+1. Create the environment file:
+
+```sh
+cp .env.example .env
+```
+
+2. Generate application key:
+
+```sh
+php artisan key:generate
+```
+
+3. Create the database and run the migrations:
+
+```sh
+mkdir -p database && touch database/database.sqlite && php artisan migrate
+```
+
+4. Generate Swagger documentation:
+
+```sh
+php artisan l5-swagger:generate
+```
+
 ### Setup Database Configuration
+
 To learn more about connecting to your Capella cluster, please follow the [instructions](https://docs.couchbase.com/cloud/get-started/connect.html).
 
 Specifically, you need to do the following:
@@ -96,7 +124,7 @@ Once the application starts, you can see the details of the application on the l
 
 ![Application Startup](./public/php-quickstart-app-startup.png)
 
-The application will run on port 8000 of your local machine (http://localhost:8000/api/documentation). You will find the Swagger documentation of the API if you go to the URL in your browser. Swagger documentation is used in this demo to showcase the different API endpoints and how they can be invoked. More details on the Swagger documentation can be found in the [appendix](#swagger-documentation).
+The application will run on port 8000 of your local machine ([http://localhost:8000/api/documentation](http://localhost:8000/api/documentation)). You will find the Swagger documentation of the API if you go to the URL in your browser. Swagger documentation is used in this demo to showcase the different API endpoints and how they can be invoked. More details on the Swagger documentation can be found in the [appendix](#swagger-documentation).
 
 ![Swagger Documentation](./public/php-quickstart-swagger.png)
 
@@ -123,152 +151,72 @@ If you would like to add another entity to the APIs, follow these steps:
 - **Create the new entity (collection) in the Couchbase bucket:** You can create the collection using the [SDK](https://docs.couchbase.com/php-sdk/current/howtos/provisioning-cluster-resources.html#collection-management) or via the [Couchbase Server interface](https://docs.couchbase.com/cloud/n1ql/n1ql-language-reference/createcollection.html).
 
 - **Define the model:** Create a new model in the `app/Models` directory, similar to the existing `Airline` model. For example, you can create a file `Hotel.php`:
-  ```php
-  namespace App\Models;
-
-  use Illuminate\Database\Eloquent\Model;
 
-  class Hotel extends Model
-  {
-      protected $bucket;
-
-      protected $fillable = [
-          'name',
-          'address',
-          'city',
-          'country',
-          'stars'
-      ];
-
-      public function __construct(array $attributes = [])
-      {
-          parent::__construct($attributes);
-          $this->bucket = app('couchbase.bucket');
-      }
-
-      // Add methods for querying, saving, and deleting Hotel data
-  }
-  ```
+```php
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Hotel extends Model
+{
+    protected $bucket;
+
+    protected $fillable = [
+        'name',
+        'address',
+        'city',
+        'country',
+        'stars'
+    ];
+
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+        $this->bucket = app('couchbase.bucket');
+    }
+
+    // Add methods for querying, saving, and deleting Hotel data
+}
+```
 
 - **Define the controller:** Create a new controller in the `app/Http/Controllers` directory, similar to the existing `AirlineController`. For example, you can create a file `HotelController.php`:
-  ```php
-  namespace App\Http\Controllers;
-
-  use Illuminate\Http\Request;
-  use App\Models\Hotel;
-
-  class HotelController extends Controller
-  {
-      // Add methods for handling HTTP requests for the Hotel entity
-  }
-  ```
-
-- **Define the routes:** In the `routes/api.php` file, define the routes for the new entity similar to the existing routes for airlines:
-  ```php
-  Route::prefix('v1/hotels')->group(function () {
-      Route::get('list', 'HotelController@index');
-      Route::get('{id}', 'HotelController@show');
-      Route::post('{id}', 'HotelController@store');
-      Route::put('{id}', 'HotelController@update');
-      Route::delete('{id}', 'HotelController@destroy');
-  });
-  ```
-
-- **Integration tests:** Create a new test class in the `tests/Feature` directory, similar to the existing tests. For example, you can create a file `HotelIntegrationTest.php`:
-  ```php
-  namespace Tests\Feature;
-
-  use Tests\TestCase;
 
-  class HotelIntegrationTest extends TestCase
-  {
-      // Add test methods for the Hotel endpoints
-  }
-  ```
-
-### Running Self Managed Couchbase Cluster
-
-If you are running this quickstart with a self-managed Couchbase cluster, you need to [load](https://docs.couchbase.com/server/current/manage/manage-settings/install-sample-buckets.html) the travel-sample data bucket in your cluster and generate the credentials for the bucket.
+```php
+namespace App\Http\Controllers;
 
-You need to update the connection string and the credentials in the `config/couchbase.php` file:
+use Illuminate\Http\Request;
+use App\Models\Hotel;
 
-```env
-DB_CONN_STR_=couchbase://<your-couchbase-server>
-DB_USERNAME=<your-username>
-DB_PASSWORD=<your-password>
-DB_BUCKET=travel-sample
+class HotelController extends Controller
+{
+    // Add methods for handling HTTP requests for the Hotel entity
+}
 ```
 
-Replace `<your-couchbase-server>`, `<your-username>`, and `<your-password>` with your actual Couchbase server details and credentials.
-> **NOTE:** Couchbase must be installed and running prior to running the Spring Boot app.### Extending API by Adding New Entity
-
-If you would like to add another entity to the APIs, follow these steps:
-
-- **Create the new entity (collection) in the Couchbase bucket:** You can create the collection using the [SDK](https://docs.couchbase.com/php-sdk/current/howtos/provisioning-cluster-resources.html#collection-management) or via the [Couchbase Server interface](https://docs.couchbase.com/cloud/n1ql/n1ql-language-reference/createcollection.html).
-
-- **Define the model:** Create a new model in the `app/Models` directory, similar to the existing `Airline` model. For example, you can create a file `Hotel.php`:
-  ```php
-  namespace App\Models;
-
-  use Illuminate\Database\Eloquent\Model;
-
-  class Hotel extends Model
-  {
-      protected $bucket;
-
-      protected $fillable = [
-          'name',
-          'address',
-          'city',
-          'country',
-          'stars'
-      ];
-
-      public function __construct(array $attributes = [])
-      {
-          parent::__construct($attributes);
-          $this->bucket = app('couchbase.bucket');
-      }
-
-      // Add methods for querying, saving, and deleting Hotel data
-  }
-  ```
-
-- **Define the controller:** Create a new controller in the `app/Http/Controllers` directory, similar to the existing `AirlineController`. For example, you can create a file `HotelController.php`:
-  ```php
-  namespace App\Http\Controllers;
-
-  use Illuminate\Http\Request;
-  use App\Models\Hotel;
-
-  class HotelController extends Controller
-  {
-      // Add methods for handling HTTP requests for the Hotel entity
-  }
-  ```
-
 - **Define the routes:** In the `routes/api.php` file, define the routes for the new entity similar to the existing routes for airlines:
-  ```php
-  Route::prefix('v1/hotels')->group(function () {
-      Route::get('list', 'HotelController@index');
-      Route::get('{id}', 'HotelController@show');
-      Route::post('{id}', 'HotelController@store');
-      Route::put('{id}', 'HotelController@update');
-      Route::delete('{id}', 'HotelController@destroy');
-  });
-  ```
+
+```php
+Route::prefix('v1/hotels')->group(function () {
+    Route::get('list', 'HotelController@index');
+    Route::get('{id}', 'HotelController@show');
+    Route::post('{id}', 'HotelController@store');
+    Route::put('{id}', 'HotelController@update');
+    Route::delete('{id}', 'HotelController@destroy');
+});
+```
 
 - **Integration tests:** Create a new test class in the `tests/Feature` directory, similar to the existing tests. For example, you can create a file `HotelIntegrationTest.php`:
-  ```php
-  namespace Tests\Feature;
 
-  use Tests\TestCase;
+```php
+namespace Tests\Feature;
+
+use Tests\TestCase;
 
-  class HotelIntegrationTest extends TestCase
-  {
-      // Add test methods for the Hotel endpoints
-  }
-  ```
+class HotelIntegrationTest extends TestCase
+{
+    // Add test methods for the Hotel endpoints
+}
+```
 
 ### Running Self Managed Couchbase Cluster
 
@@ -277,7 +225,6 @@ If you are running this quickstart with a self-managed Couchbase cluster, you ne
 You need to update the connection string and the credentials in the `config/couchbase.php` file:
 
 ```php
-
 <?php
 return [
     'host' => env('DB_CONN_STR', 'couchbase://<your-couchbase-server>'),
@@ -288,7 +235,8 @@ return [
 ```
 
 Replace `<your-couchbase-server>`, `<your-username>`, and `<your-password>` with your actual Couchbase server details and credentials.
-> **NOTE:** Couchbase must be installed and running prior to running the Spring Boot app.
+
+> **NOTE:** Couchbase must be installed and running prior to running the Laravel application.
 
 ### Swagger Documentation
 
@@ -307,4 +255,3 @@ You can try out an API by clicking on the "Try it out" button next to the endpoi
 #### Models
 
 Swagger documents the structure of request and response bodies using models. These models define the expected data structure using JSON schema and are extremely helpful in understanding what data to send and expect.
-