API blueprint Document and some tweaks

Author: joselfonseca

.gitignore

@@ -6,4 +6,5 @@ Homestead.json
 .env
 yarn.lock
 /public/css/
-/public/js/
+/public/js/
+/packages

app/Http/Controllers/Users/UsersController.php

@@ -5,6 +5,7 @@
 use Illuminate\Http\Request;
 use App\Http\Controllers\Controller;
 use App\Contracts\Users\UsersServiceContract;
+use Joselfonseca\LaravelApiTools\Traits\ResponseBuilder;
 
 /**
  * Class UsersController
@@ -13,6 +14,8 @@
 class UsersController extends Controller
 {
 
+    use ResponseBuilder;
+
     /**
      * @var UsersServiceContract
      */
@@ -26,6 +29,7 @@ public function __construct(UsersServiceContract $service)
     {
         $this->service = $service;
         $this->middleware('permission:List users')->only('index');
+        $this->middleware('permission:List users')->only('show');
         $this->middleware('permission:Create users')->only('store');
         $this->middleware('permission:Update users')->only('update');
         $this->middleware('permission:Delete users')->only('destroy');
@@ -37,7 +41,17 @@ public function __construct(UsersServiceContract $service)
     public function index()
     {
         $users = $this->service->get();
-        return $this->service->transform($users);
+        return response()->json($this->service->transform($users));
+    }
+
+
+    /**
+     * @param $id
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function show($id)
+    {
+        return response()->json($this->service->transform($this->service->find($id)));
     }
 
     /**
@@ -47,8 +61,8 @@ public function index()
     public function store(Request $request)
     {
         $attributes = $request->all();
-        $this->service->create($attributes);
-        return response()->json()->setStatusCode(201);
+        $user = $this->service->create($attributes);
+        return $this->created(url('api/users/'.$user->uuid), $this->service->transform($user));
     }
 
     /**
@@ -70,6 +84,6 @@ public function update(Request $request, $uuid)
     public function destroy(Request $request, $uuid)
     {
         $this->service->delete($uuid);
-        return response()->json()->setStatusCode(204);
+        return $this->noContent();
     }
 }

app/Services/Users/UsersService.php

@@ -6,7 +6,6 @@
 use League\Fractal\TransformerAbstract;
 use App\Transformers\Users\UserTransformer;
 use App\Contracts\Users\UsersServiceContract;
-use League\Fractal\Serializer\JsonApiSerializer;
 use Joselfonseca\LaravelApiTools\Contracts\FractalAble;
 use Joselfonseca\LaravelApiTools\Contracts\ValidateAble;
 use Joselfonseca\LaravelApiTools\Traits\FractalAbleTrait;
@@ -79,14 +78,6 @@ public function setTransformer() : TransformerAbstract
         return app(UserTransformer::class);
     }
 
-    /**
-     * @return JsonApiSerializer
-     */
-    public function setSerializer()
-    {
-        return new JsonApiSerializer(url('api'));
-    }
-
     /**
      * @param int $limit
      * @return mixed

composer.lock

@@ -0,0 +1,17 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Prefix
+    |--------------------------------------------------------------------------
+    |
+    | This is the prefix you use for your routes
+    |
+    */
+
+    'prefix' => 'api'
+
+
+];

config/api.php

@@ -12,7 +12,7 @@
     | any other location as required by the application or its packages.
     */
 
-    'name' => 'Laravel',
+    'name' => 'Laravel API',
 
     /*
     |--------------------------------------------------------------------------

config/app.php

@@ -0,0 +1,13 @@
+<?php
+
+
+return [
+    // The locator to bind
+    'locator' => 'Joselfonseca\LaravelTactician\Locator\LaravelLocator',
+    // The inflector to bind
+    'inflector' => 'League\Tactician\Handler\MethodNameInflector\HandleInflector',
+    // The extractor to bind
+    'extractor' => 'League\Tactician\Handler\CommandNameExtractor\ClassNameExtractor',
+    // The bus to bind
+    'bus' => 'Joselfonseca\LaravelTactician\Bus'
+];