Laravel API controller structure?

Question

Which one this controller structure for user api make sense

Separate controller for UI and API for every api version

/app/controllers/UsersController.php
/app/controllers/api/v1/ApiUsersController.php

or

Separate controller for UI and API and handle versioning in code

/app/controllers/UsersController.php
/app/controllers/api/ApiUsersController.php

or

Use single controller, detect /api/ call within router. Return html/json depending on the url.

/app/controllers/UsersController.php

The first option is clear and direct. The last one would eventually be confusing if you open your API to the public. — Hass
– Hass, Commented Nov 25, 2013 at 1:31

mpj.dev · Accepted Answer · 2013-11-25 03:35:53Z

8

Definitely the first option is the best out of the three, and the reasons are scalability and maintenance.

If you use only one controller, as proposed in the third method, you will end up soon with a messy class with thousands of lines. Not only this is not going to scale well, but it will be hard to work with for you and your teammates.

The second choice is better than the third one, but still not the best. It's a better practice to be supporting API versioning from the start, and it will keep your routes, files and namespaces more organized.

By the way, instead of naming it ApiUserController you can use UserController too, as long as you are namespacing properly. So, you could have \UserController and Api\V1\UserController existing together.

answered Nov 25, 2013 at 3:35

mpj.dev

5,3772 gold badges33 silver badges47 bronze badges

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

2 Comments

AHeavyObject Over a year ago

Manuel, can you please explain why to use different controllers if all the difference would be either to output JSON or HTML. As for me having the same controller with only different return statements is a DRY violation. I must be not taking something into consideration. Do you mean that sooner or later the Web/API corresponding methods would become more heavy then just it seems to me know?

James mcconnon Over a year ago

I would imagine, it is just because if you have one method for example index in your API controller that returns json, but you want a web controller with index to return a vew then it won't get messy trying to have logic to seperate the requests to requiring json and can just have clearly seperated controllers to handle each things. Keeps your code contained.

user3029589 · Accepted Answer · 2013-11-25 00:34:25Z

1

Personal opinion. I prefer 1st option. All in 1 app, and versioning via namespace.

answered Nov 25, 2013 at 0:34

user3029589

Collectives™ on Stack Overflow

Laravel API controller structure?

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related