[API] Best practice when designing endpoint

When your application has multiple user roles. You should think about the API endpoint. Not only for coding but for debugging and testing purposes.

In my experience, Whenever you design Back-end API you should separate the Controller for every user role.

Example:

LoanController: api/v1/loan
AdminLoanController: api/v1/admin/loan

This method will help you bring more benefits as below:

1. You will know which controller will be used for which role
2. When you want to change user business -> focus on LoanController
3. When you want to change admin business -> focus on AdminLoanController
4. Easily to implement role right permission for API
5. When you changed in User part. There is no impact on the Admin part.
6. Easy to debug
7. Easy to scale

Of course, You need to follow

1. RESTFUL API pattern
2. Versioning
3. Naming convention