argezeit/apigility-client

Client for REST and RPC webservices

Client for Apigility REST and RPC webservices

Installation

composer require jolicht/apigility-client, _(*1)

Configuration for Zend Framework 2

Register Abstract Service Factory

Register Jolicht\\ApigilityClient\\ClientAbstractServiceFactory as abstract service in service manager:, _(*2)

'service_manager' => [
    'abstract_factories' => [
        'Jolicht\\ApigilityClient\\ClientAbstractServiceFactory'
    ]
],

Configure Apigility Http Client

Add config key apigility_http_client to your prefered config file. (Applicaction Level e.g.: 'config/autoload/global.php; Module level e.g.: config/module.config.php, _(*3)

'apigility_http_client' => [
    'NameOfFirstClient' => [
        'base_uri' => 'http://your-apigility-service-uri.dev',
            'default_headers' => [
                'Accept' => 'application/json',
                'Content-Type' => 'application/json'
            ],
            'http_client_options' => [
                'timeout' => 42
            ],
            'throw_exceptions' => false,
        ]
    ],
    'NameOfSecondClient' => [
        'base_uri' => 'http://your-second-apigility-service-uri.dev',
            'default_headers' => [
                'Accept' => 'application/json',
                'Content-Type' => 'application/json'
            ],
            'http_client_options' => [
                'timeout' => 10
            ],
        ]
    ],
],

Always set default_headers Accept and Content-Type to prevent content type errors. If throw_exceptions is true exception is thrown on invalid response status code., _(*4)

Usage

Get Apigility http client instance

Call ServiceManager::get or ServiceLocator::get with configured Service Name as param:, _(*5)

$firstClient = $serviceManager->get('NameOfFirstClient');
$secondClient = $serviceManager->get('NameOfSecondClient');

Operations

Create:, _(*6)

$response = $client->create('/api-route', $data);

Fetch:, _(*7)

$response = $client->fetch('/api-route', 17);

FetchAll:, _(*8)

$response =  $client->fetchAll('/api-route'); // without query data 
$response =  $client->fetchAll('/api-route', $queryData); // with query data

Patch:, _(*9)

$response = $client->patch('/api-route', 17, $data);

Update:, _(*10)

$response = $client->update('/api-route', 17, $data);

Call any Http Method:, _(*11)

$response = $client->call('/api-route'); // HTTP GET
$response = $client->call('/api-route/3'); // HTTP GET
$response = $client->call('/api-route', 'GET', $data); // HTTP GET with query parameters
$response = $client->call('/api-route', 'POST', $data); // HTTP POST with content data

Not yet implemented:, _(*12)

• delete
• deleteList
• replaceList