Added Users Api With Proper Transformer

Author: g0ld3lux

api/V1/Users/Controllers/UsersController.php

@@ -13,12 +13,16 @@
 
     public function __construct()
     {
-        $this->scopes(['read_user_data']);
+        // You Should Enable api.auth middleware
+        // This is Useful for Put Patch Delete 
+        // For a user
+        // $this->scopes(['read_user_data']);
     }
 
     public function index()
     {
         $users = User::all();
+        // Use Collection Property for Collections
         return $this->collection($users, new UserTransformer);
     }
    /**   
@@ -32,9 +36,13 @@ public function index()
     public function show($id)
     {
         try {
-            return User::findOrFail($id);
+            $user = User::findOrFail($id);
+            // Use Item Property for Single Item to be Returned
+            return $this->item($user, new UserTransformer);
         }catch (\Illuminate\Database\Eloquent\ModelNotFoundException $e){
+
             $api=  app(\Dingo\Api\Http\Response\Factory::class);
+          // Override the Custom Errors 
           return $api->errorNotFound("Requested resource with id={$id} where not found.");
         }
 

api/V1/Users/Transformers/UserTransformers.php renamed to api/V1/Users/Transformers/UserTransformer.php

@@ -29,7 +29,7 @@ public function transform(User $user)
             'on_trial'      => (bool) $user->on_trial,
             'subscribed'    => (bool) $user->subscribed,
             'resent'        => (int) $user->resent,
-            'settings'      => $user->settings
+            'settings'      => (array) $user->settings
         ];
     }
 

config/auth_scaffold.php

@@ -3,7 +3,9 @@
 return [
 
     'sign_up' => [
-        'release_token' => env('SIGN_UP_RELEASE_TOKEN'),
+        // If You want User a New User Given a New Token
+        // This Will Log in the User to the App
+        'release_token' => env('SIGN_UP_RELEASE_TOKEN', false),
         'validation_rules' => [
             'first_name' => 'required',
             'last_name' => 'required',
@@ -27,6 +29,8 @@
     ],
 
     'reset_password' => [
+        // If You Want the User Who Request Reset be Login
+        // He Will be Given a Token
         'release_token' => env('PASSWORD_RESET_RELEASE_TOKEN', false),
         'validation_rules' => [
             'token' => 'required',

routes/api.php

@@ -20,6 +20,8 @@
 |--------------------------------------------------------------------------
 |
 */
+
+// Default Sample Middleware
 $api->version('v1', function ($api) {
     $api->group(['middleware' => ['auth:api']], function ($api) {
         $api->group(['middleware' => ['roles'],
@@ -65,4 +67,16 @@
         // we get token from the url segment
         // required: email, password , and password_confirmation , token
     });
+});
+
+/*
+|--------------------------------------------------------------------------
+| User Api 
+| With Proper Transformer Set Up
+|--------------------------------------------------------------------------
+|
+*/
+$api->version('v1', function ($api) {
+$api->get('/users', ['as' => 'api.index', 'uses' => 'Api\V1\Users\Controllers\UsersController@index']);
+$api->get('/user/{id}', ['as' => 'api.index', 'uses' => 'Api\V1\Users\Controllers\UsersController@show']);
 });