Finish user endpoints

Author: shalvah

app/Http/Controllers/UserController.php

@@ -13,16 +13,18 @@
 class UserController extends Controller
 {
     /**
-     * View all users.
+     * View all users
      *
      * This endpoint uses a custom Scribe strategy that parses a
-     * `@usesPaginationParameters` annotation.
+     * `@usesPagination` annotation to add some query parameters.
      *
-     * @usesPaginationParameters
+     * The sample response is gotten by Scribe making a test API call (aka "response call").
+     *
+     * @usesPagination
      */
     public function index()
     {
-        //
+        return UserResource::collection(User::all());
     }
 
     /**
@@ -38,9 +40,33 @@ public function store(CreateUserRequest $request)
         return ['user' => $user, 'token' => $token->plainTextToken];
     }
 
+    /**
+     * Authenticate
+     *
+     * Get a new API token.
+     *
+     * <aside>Yes, we know you can impersonate any user.🙄</aside>
+     *
+     * @response {"token": "2|KLDoUXc68Ko0JaFDZoX9qYkUqWglwdGxQsvTGBCg"}
+     * @responseField token The new API token. Valid forever.
+     */
+    public function authenticate($id)
+    {
+        $token = User::findOrFail($id)->createToken('default');
+        return ['token' => $token->plainTextToken];
+    }
+
     /**
      * Fetch a user
      *
+     * This endpoint's response uses an Eloquent API resource, so we tell Scribe that using an annotation,
+     * and it figures out how to generate a sample. The 404 sample is gotten from a "response file".
+     *
+     * <aside class="success">Also, pretty cool: this endpoint's URL parameters were figured out entirely by Scribe!</aside>
+     *
+     * @apiResource App\Http\Resources\UserResource
+     * @apiResourceModel App\Models\User with=sideProjects
+     * @responseFile 404 responses/not_found.json {"resource": "user"}
      */
     public function show($id)
     {

app/Http/Resources/UserResource.php

@@ -18,6 +18,7 @@ public function toArray($request)
             'id' => $this->id,
             'name' => $this->name,
             'email' => $this->email,
+            'side_projects' => $this->sideProjects,
         ];
     }
 }

app/Models/User.php

@@ -41,4 +41,9 @@ class User extends Authenticatable
     protected $casts = [
         'email_verified_at' => 'datetime',
     ];
+
+    public function sideProjects()
+    {
+        return $this->hasMany(SideProject::class);
+    }
 }

database/factories/SideProjectFactory.php

@@ -22,7 +22,8 @@ class SideProjectFactory extends Factory
     public function definition()
     {
         return [
-            //
+            'name' => $this->faker->words(3, true),
+            'description' => $this->faker->sentence,
         ];
     }
 }

routes/api.php

@@ -45,11 +45,6 @@
 Route::post('users/', [UserController::class, 'store']);
 Route::get('users/{id}', [UserController::class, 'show']);
 Route::get('users/', [UserController::class, 'index']);
+Route::post('users/{id}/auth', [UserController::class, 'authenticate']);
 
 Route::apiResource('sideprojects', SideProjectController::class);
-
-Route::post('users/auth', function (Request $request) {
-    $token = $request->user()->createToken();
-
-    return ['token' => $token->plainTextToken];
-});

storage/responses/not_found.json

@@ -0,0 +1,4 @@
+{
+  "message": "Not found",
+  "resource": ""
+}