Alimentalos/Backend

View on GitHub
app/Http/Controllers/Resource/ShowController.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php

namespace App\Http\Controllers\Resource;

use App\Contracts\Resource;
use App\Http\Controllers\Controller;
use App\Http\Requests\Resource\ShowRequest;
use Illuminate\Http\JsonResponse;
use Illuminate\View\View;

class ShowController extends Controller
{
    /**
     * @OA\Get(
     *      path="/{resource}/{uuid}",
     *      operationId="getResource",
     *      tags={"Resources"},
     *      summary="Get specific resource.",
     *      description="Returns the specified resource as JSON Object.",
     *      @OA\Parameter(
     *          name="uuid",
     *          description="Unique identifier of resource",
     *          required=true,
     *          in="path",
     *          @OA\Schema(
     *              type="string"
     *          )
     *      ),
     *     @OA\Parameter(
     *         name="resource",
     *         in="path",
     *         description="Resource type that need to be considered",
     *         required=true,
     *         @OA\Schema(
     *         type="string",
     *           @OA\Items(
     *               type="string",
     *               enum={"users", "devices", "groups", "pets", "actions", "locations", "geofences", "photos", "comments", "alerts"},
     *               default="devices"
     *           ),
     *         )
     *     ),
     *      @OA\Response(
     *          response=200,
     *          description="Resource retrieved successfully"
     *       ),
     *      @OA\Response(response=400, description="Bad request"),
     *      @OA\Response(response=404, description="Resource not found")
     * )
     * Get specific instance of resource.
     *
     * @param ShowRequest $request
     * @param $resource
     * @return JsonResponse|View
     */
    public function __invoke(ShowRequest $request, Resource $resource)
    {
        $resource->load($resource->lazy_relationships);
        return $request->wantsJson() ?
            response()->json($resource, 200) :
            view(finder()->currentResource() . '.show')->with(['instance' => $resource]);
    }
}