Laravel API Architecture - best practices

Question

I'm implementing an API that can create clients and create contacts. Contacts may be associated with a client.

I have my ClientController.php with all the CRUD methods.

I also have a ContactController.php with all the CRUD methods.

I want to allow a contact to be created and assigned to a client all in the one API call.

I was thinking the best way would be add a function to my ClientController and call it via the API: /api/client/6/addContact

public function addContact($clientId, Request $request) {
   $contact = new Contact($request->all())->save();

   $client = Client::find($clientId)->attach($contact->id);

   return response()->json(null, 200);

}

But my issue is that the method to add a contact (and validate it) is in the ContactController.php, so i'm doubling up on the code. How can I use the ContactController@store method from the ClientController@addContact ?

Is there a common API architecture for these types of issues?

Thanks!

You could use a service pattern. In a project I'm working on right now, I make plain PHP classes in an App\Services namespace that I can then inject into my controllers (or other services) to provide functionality, passing in any required HTTP data like get/post variables to the service. — Nathan
– Nathan, Commented Aug 23, 2018 at 0:01
@Nathan maybe he should use eloquent observers. he is not trying to use a third party library.Ben Southall, if you use Laravel 5.3 or plus, you should use observers because you are observing add client method. for more info read this please : laravel.com/docs/5.3/eloquent#observers — Thamer
– Thamer, Commented Aug 23, 2018 at 0:17
@Thamerbelfkih thanks for this, i read about observers many times but never thought i could use it to achieve this — Hussein
– Hussein, Commented Aug 23, 2018 at 0:18
so as i understood you have a client that is saved, now you want to create a contact and attach it to a client, if so why don't you just call $client->contacts()->attach($contact->id) in the store method of ContactController ? — Hussein
– Hussein, Commented Aug 23, 2018 at 0:30
Thanks @Nathan could you give me an example of your service? I can seem to find this pattern anywhere in the laravel docs. — Ben Southall
– Ben Southall, Commented Aug 23, 2018 at 2:08

Brian Lee · Accepted Answer · 2018-08-23 02:03:31Z

3

I'd suggest using a nested api resource route:

// generate the controller class
php artisan make:controller Api/ContactController --api

// create the route definitions
Route::apiResource('clients.contacts', 'ContactController');

The above creates the routes:

GET /clients/{client}/contacts
POST /clients/{client}/contacts
GET /clients/{client}/contacts/{contact}
PUT/PATCH /clients/{client}/contacts/{contact}
DELETE /clients/{client}/contacts/{contact}

answered Aug 23, 2018 at 2:03

Brian Lee

18.3k3 gold badges45 silver badges55 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Mark C. · Accepted Answer · 2018-08-23 02:35:50Z

0

You are creating a one to many relationship. I would focus on establishing that relationship in eloquent and then the rest will fall into place:

https://laravel.com/docs/5.6/eloquent-relationships#one-to-many

After you create the relationship correctly your API calls will be structured around a json string (object) that will have one client and one or more contacts.

If you have any questions, please ask, but this basic strategy will get you to where you want to go.

answered Aug 23, 2018 at 2:35

Mark C.

4084 silver badges14 bronze badges

Collectives™ on Stack Overflow

Laravel API Architecture - best practices

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related