atog/simple-api-client

Simple API Client with cUrl

simple-api-client

![Travis][ico-testing] [![Quality Score][ico-code-quality]][link-code-quality] ![Total Downloads][ico-downloads], _(*1)

The simple-api-client library provides an easy way to build wrappers for public REST APIs., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require atog/simple-api-client, <sub>(*4)</sub>

## Usage
### Classes
#### Client
The `Client` Class contains the basic Informations about the API liek the `$domain`. It has to extend the abstract class `Atog\Api\Client`
```php
class Client extends \Atog\Api\Client
{
    protected $domain = 'http://example.com/api/v1';
}

Endpoints

Endpoints provide the functions to query the resources of the API., <sub>(*5)</sub>

class TestEndpoint extends \Atog\Api\Endpoint
{
    protected $endpoint = 'foo';

    public function find($slug)
    {
        // https://example.com/api/v1/foo/$slug gets called
        $this->respond(
            $this->client->get($this->getEndpointUrl($slug, true))
        ); 
    }
}

Models

The Models are the datastructures of the resources. Attributes can easly be changed with get and set mutators (much like the Eloquent Mutators from Laravel: https://laravel.com/docs/5.2/eloquent-mutators), <sub>(*6)</sub>

class TestModel extends Model
{
    public function getNameAttribute($value)
    {
        return strtoupper($value);
    }

    public function setFirstNameAttribute($value)
    {
        $this->attributes['first_name'] = strtolower($value);
    }

    public function setContactsAttribute($value)
    {
        $this->attributes['contacts'] = $this->makeCollection($value, Contacts::class);
    }
}

Initialization

The first parameter defines all endpoints you are using. The second provides some options about the models or cUrl. In the models config we can bind a model to an endpoint, <sub>(*7)</sub>

// new Client(array $endpoints, array $config = [])
$client = new Client(
    [
        TestEndpoint::class
    ],
    [
        'models' => [
            'TestEndpoint' => TestModel::class
        ],
        'curl' => [
            CURLOPT_TIMEOUT => 60
        ]
    ]
);
$foo = $client->testEndpoint->find(1); // GET http://example.com/api/v1/foo/1

Change log

1.1.0

• added support for query params
• added helper method to return api reponse

1.0.0

• Initial Release

Testing

bash $ composer test, <sub>(*8)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*9)</sub>