Download the PHP package kielabokkie/laravel-guzzle-api-service without Composer
On this page you can find all versions of the php package kielabokkie/laravel-guzzle-api-service. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kielabokkie/laravel-guzzle-api-service
More information about kielabokkie/laravel-guzzle-api-service
Files in kielabokkie/laravel-guzzle-api-service
Package laravel-guzzle-api-service
Short Description A base class for interacting with external APIs via Guzzle
License MIT
Informations about the package laravel-guzzle-api-service
Laravel Guzzle API Service
Note: This package is still being developed and is not production ready. Use at your own risk!
Installation
Install the package via composer:
composer require kielabokkie/laravel-guzzle-api-service
Package configuration
Publish the config file by running the following command:
This is the contents of the file that will be published at config/api-service.php
:
Setup
To make use of the base API Client class you'll need to add the required $baseUrl
to set the base URL of your API. You'll also have to call the $this->setClient();
function in the constructor of your service class.
To make it easy to get started you can use the following command to scaffold your API Service class:
This will create a class called HttpBinService.php
in the app/Support/Services
folder. All you have to do is set your $baseUrl
and you are good to go.
Note: If you would like your classes to be placed somewhere else you can overwrite the namespace
variable in the api-service.php
config file.
Usage
Get request
Now to execute a GET
request you can simply do the following:
This is pretty basic stuff and the same as you would normally do a GET
request with Guzzle.
Adding default headers
APIs often require you to add a specific header to every request, for example for authorisation purposes. Instead of having to pass that as an option with every request you can add the following function at the top of your service class:
Adding default query parameters
You can add default query parameters to every request automatically in a similar way:
This will automatically append the token as a get parameter like so: https://httpbin.org/get?token=your-token
.