Using Laravel Service Container for third-party APIs

Question

I'm trying to make proper use of Laravel's Service Container to instantiate a connection to a third-party API and use it across my Controllers. Below I added my API connection into the register method of Laravel's AppServiceProvider. In my Controller constructor, I provide a handle to that connection that can be used freely inside the Controller wherever a connection is needed. Does this example demonstrate the best use of a Service Container? Should I replace my reference to 'bind' with 'singleton' instead?

use App\Http\Clients\RestClient;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->bind(RestClient::class, function($app)
        {
            $this->api = new RestClient();
            $this->api->setUrl(getenv('API_REST_URL'))
                    ->setUsername(getenv('API_USERNAME'))
                    ->setPassword(getenv('API_PASSWORD'))
                    ->connect();

            return $this->api;
        });
    }
} 

class LoginController extends Controller 
{
    public function __construct(RestClient $api) 
    {
        $this->api = $api;
    }

    public function postLogin() 
    {
        $results = $this->api->search('Users');
    }
}

tersakyan · Accepted Answer · 2017-10-30 10:52:19Z

1

Your usage is not wrong. But, this usage stands against Dependency Injection. You don't need to use custom service provider. But you can inject RestClient by using Laravel's class registration.

Here is an example from Laravel's documentation. You can setup RestClient here and you can inject it to RestApiService as well.

$this->app->singleton(Connection::class, function ($app) {
    return new Connection(config('riak'));
});

answered Oct 30, 2017 at 10:52

tersakyan

7726 silver badges15 bronze badges

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

5 Comments

user633440 Over a year ago

I have something like the above in my ServiceProvider using the RestAPIService but it makes no difference. $this->app->bind('App\Services\RestApiService', function ($app) { return new RestApiService(); }); If I don't use the ServiceProvider and setup the RestClient in the singleton, where does the singleton live?

tersakyan Over a year ago

Why don't you inject RestClient to RestApiService when you are registering/binding class? Your example of course won't any difference. So RestApiService will get RestClient $restClient parameter, which already initialized. You won't need to create a new class for it.

tersakyan Over a year ago

@KarlHill this is what i want to say. You can also use your legacy RestApiService. And you can inject this service to your controller, instead of injecting 3rd party client. Your current usage is much better than previous. I would like to learn if there is any other way to inject.

user633440 Over a year ago

@terasakyan Thank you. Have you tried Laravel Passport?

tersakyan Over a year ago

@KarlHill yes :)

Collectives™ on Stack Overflow

Using Laravel Service Container for third-party APIs

1 Answer 1

5 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Related