PHPackages                             kkedzierski/rest-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. kkedzierski/rest-api-client

ActiveLibrary[HTTP & Networking](/categories/http)

kkedzierski/rest-api-client
===========================

Rest Api client library to send HTTP requests and retrive response

1.0(4y ago)06MITPHP

Since Jan 1Pushed 4y ago1 watchersCompare

[ Source](https://github.com/kkedzierski/RestApiClient)[ Packagist](https://packagist.org/packages/kkedzierski/rest-api-client)[ RSS](/packages/kkedzierski-rest-api-client/feed)WikiDiscussions master Synced today

READMEChangelog (1)Dependencies (1)Versions (3)Used By (0)

Rest Api Client
===============

[](#rest-api-client)

library to send HTTP requests and retrieve response object
----------------------------------------------------------

[](#library-to-send-http-requests-and-retrieve-response-object)

### Instalation

[](#instalation)

---

To use library in another project write in console:
`composer install`
`composer require kkedzierski/rest-api-client`

---

### Usage

[](#usage)

#### After instalation composer requirements to use library at the top of file write

[](#after-instalation-composer-requirements-to-use-library-at-the-top-of-file-write)

```
use RestApiClient\RestApiClient;
require_once __DIR__ . './vendor/autoload.php';

```

#### And create instance of class with base URI

[](#and-create-instance-of-class-with-base-uri)

ex.

```
$RAC = new RestApiClient("https://api.github.com");

```

#### To add to header use addToHeader method,method take two parameters Type and Value

[](#to-add-to-header-use-addtoheader-methodmethod-take-two-parameters-type-and-value)

ex.

```
$rac->addToHeader("User-Agent", "Test REST API Client");

```

#### To add additonal parmeters like gets or header create array and add this array as an argument to request methods

[](#to-add-additonal-parmeters-like-gets-or-header-create-array-and-add-this-array-as-an-argument-to-request-methods)

ex. array:

```
$additonalParamArr = [
    "header" =>
        ["User-Agent: Test REST API Client",
        "Authorization: token api_token"]
];

```

#### To make HTTP Request use methods get, post, put, patch, delete

[](#to-make-http-request-use-methods-get-post-put-patch-delete)

ex.

```
$response = $RAC->get('/user/repos');

```

#### To specify endpoint to GET PUT PATCH or DELETE method you can use parametr value argument

[](#to-specify-endpoint-to-get-put-patch-or-delete-method-you-can-use-parametr-value-argument)

ex.

```
$response = $RAC->get('/user/:id/repos', 123);

```

#### GET method parameters

[](#get-method-parameters)

- string $resource must start with "/" ex. /products or /products/:id
- string|int $parameterValue parametr required if is specific in resource , default = ''
- array|null $additionalField ex. header, default = null

#### POST method parameters

[](#post-method-parameters)

- string $resource must start with "/" ex. /products or /products/:id
- array $postData data to send
- array|null $additionalField ex. header, default = null

#### PUT and PATCH methods parameters

[](#put-and-patch-methods-parameters)

- string $resource must start with "/" ex. /products or /products/:id
- string|int $parameterValue parametr required if is specific in resource , default = ''
- array $updateData data to update
- array|null $additionalField ex. header, default = null

#### DELETE method parameters

[](#delete-method-parameters)

- string $resource must start with "/" ex. /products or /products/:id
- string|int $parameterValue parametr required if is specific in resource , default = ''
- array|null $additionalField ex. header, default = null

#### every methods return response object with methods

[](#every-methods-return-response-object-with-methods)

- getUrl();
- getStatusCode();
- getHeader();
- getHeaderLine(string);
- getBody();
- getContent();

#### Rest Api Clinet object have additional methods:

[](#rest-api-clinet-object-have-additional-methods)

- getUrl();
- getHeader();
- getHeaderLine(string);

### Example usage

[](#example-usage)

```