Building a Basic Api Tutorial Part 4 Resources

Data display on Return:

Making use of Collections / Resources we can next manipulate our response: https://laravel.com/docs/6.x/eloquent-resources

Lets setup one for our User Model:

• php artisan make:resource UserResource and php artisan make:resource UserCollection to generate our resource and collection. At the top of the controller:

    /**
     * Resource for item.
     *
     * @var mixed instance of \Illuminate\Http\Resources\Json\JsonResource
     */
    protected $resourceSingle = UserResource::class;

    /**
     * Resource for collection.
     *
     * @var mixed instance of \Illuminate\Http\Resources\Json\ResourceCollection
     */
    protected $resourceCollection = UserCollection::class;

Next lets setup these resources to extend our ApiResources: Open the UserResource and change the definition to

use Phpsa\LaravelApiController\Http\Resources\ApiResource;

class UserResource extends ApiResource

and the UserCollection change definition to

use Phpsa\LaravelApiController\Http\Resources\ApiResource;

class UserCollection extends ApiResource

Now for some of the magic.

1) Lets standardize our response Case :

currently getting a user responds with:

{
    "data": {
        "id": 1,
        "name": "cdadmin",
        "email": "[email protected]",
        "email_verified_at": null,
        "created_at": null,
        "updated_at": null
    }
}

Now in your request add the following header: X-Accept-Case-Type: camel (or camel-case) and your response should now:

{
    "data": {
        "id": 1,
        "name": "cdadmin",
        "email": "[email protected]",
        "emailVerifiedAt": null,
        "createdAt": null,
        "updatedAt": null
    }
}

Using snake / snake-case will make sure all are snake cased.

Requests to are automatically converted from camel to snake for your database so sending:

{
	"email" : "[email protected]",
	"emailVerifiedAt" : "2019-12-19 22:47:58"
}

or

{
	"email" : "[email protected]",
	"email_verified_at" : "2019-12-19 22:47:58"
}

will work.

2. Lets limit our standard response fields:

in the UserResource add:

 protected static $defaultFields = [
        'name','email','created_at'
    ];

And your response is now:

{
    "data": {
        "name": "cdadmin",
        "email": "[email protected]",
        "createdAt": null
    }
}

And your list response will be:

{
    "data": [
        {
            "name": "cdadmin",
            "email": "[email protected]",
            "created_at": null
        },
        {
            "name": "Dr. Elna Roob Sr.",
            "email": "[email protected]",
            "created_at": "2019-12-19 20:21:04"
        },
        {
            "name": "Randy Harvey",
            "email": "[email protected]",
            "created_at": "2019-12-19 20:21:04"
        },
...

Now - you have another enpoint that say: needs the email validated at date, instead of creating a new endpoint, simply do the following: to your request:

add ?addfields=email_verified_at

-- Optionally -- api headers middleware ? 5. Seed admin User 6. Oauth + Secrets 7. Setup in postman (optionally extra postman package to get initial api points) 8. Install api-controller package.

---- End Part 1

--- start Part 2

1. • setup Users Endpoint to map to users model
2. • add Policy for security
3. • Add Resource for response
4. • Add Request for Validation
5. • Add Scope for extra scope
6. by this point should have a basic CRUD group.
7. -- Custom Endpoint -- Me - for own profile

--- end Part 2

--- start part 3 (advanced extras)

1. -- joins