PHP HTTP REST Client

, _(*1)

Simple PHP Client library that makes it easy to make REST API calls. It uses Guzzle Client as a dependencies, _(*2)

Installation

The recommended way to install this library is through Composer., _(*3)

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version of this library:, _(*4)

php composer.phar require abhilashpujari/php-restservice dev-master

After installing, you need to require Composer's autoloader:, _(*5)

require 'vendor/autoload.php';

You can then later update this library using composer:, _(*6)

bash php composer.phar update, _(*7)

## Usage, _(*8)

1 GET Request, _(*9)

```php use RestService\RestService;, _(*10)

$restService = new RestService(); $response = $restService ->setEndpoint('https://jsonplaceholder.typicode.com') ->get('/posts/1'); ```, _(*11)

2 POST Request, _(*12)

$restService
     ->setEndpoint('https://jsonplaceholder.typicode.com')
     ->post('/posts');

3 PUT Request, _(*13)

$restService
     ->setEndpoint('https://jsonplaceholder.typicode.com')
     ->put('/posts/1',
         [
             'id' => 1,
             'text' => 'Test'
         ]
     );

4 PATCH Request, _(*14)

$restService
     ->setEndpoint('https://jsonplaceholder.typicode.com')
     ->patch('/posts/1',
         [
             'id' => 1,
             'text' => 'Test'
         ]
     );

5 DELETE Request, _(*15)

$restService
     ->setEndpoint('https://jsonplaceholder.typicode.com')
     ->delete('/posts/1');

6 A fire and forget request which is useful in scenario where we fire the request and aren't concerned of the response, it can be done by setting setIsFireAndForget(true), _(*16)

$restService
     ->setEndpoint('https://jsonplaceholder.typicode.com')
     ->setIsFireAndForget(true)
     ->post('/posts');

7 Request with some custom headers, , it can be done by setting setRequestHeaders(headers array), _(*17)

$restService
     ->setEndpoint('https://jsonplaceholder.typicode.com')
     ->setRequestHeaders([
         'auth' => 'somevalue'
     ])
     ->post('/posts');

8 Request in which we need the response data which includes status code, headers, body etc, which can be done by setting request method 4th parameter to false, _(*18)

$response = $restService
     ->setEndpoint('https://jsonplaceholder.typicode.com')
     ->get('/posts/1', [], [], false);

 var_dump($response->getHeaders());
 var_dump($response->getBody());

9 PURGE Request (Can be used for cache invalidation Eg:: varnish, nginx cache), _(*19)

```php use RestService\RestService;, _(*20)

$restService = new RestService(); $response = $restService ->setEndpoint('https://jsonplaceholder.typicode.com') ->purge('/posts/1'); ```, _(*21)