someline / rest-api-client
An elegant and smart Rest API Client with OAuth2 authentication support. Build for Laravel and Someline Starter.
Installs: 13 299
Dependents: 3
Suggesters: 0
Security: 0
Stars: 8
Watchers: 3
Forks: 7
Open Issues: 0
Requires
- php: >=5.5.9
- guzzlehttp/guzzle: ~6.0
- laravel/framework: 5.2.*|5.3.*|5.4.*|5.5.*|5.6.*|5.7.*|5.8.*
Requires (Dev)
- phpunit/phpunit: 4.*
README
Someline Starter API Client is an elegant and smart Rest API Client with OAuth2 authentication support.
Build for Laravel and Someline Starter.
It can be used for accessing APIs created using Someline Starter framework.
Install
Via Composer
Install composer package to your laravel project
composer require someline/rest-api-client
Add Service Provider to config/app.php
'providers' => [ ... Someline\Rest\RestClientServiceProvider::class, ... ],
Publishing config file.
php artisan vendor:publish
After published, config file for Rest Client is config/rest-client.php
, you will need to config it to use Rest Client.
Usage
$restClient = new \Someline\Rest\RestClient('someline-starter'); $restClient->setOAuthUserCredentials([ 'username' => 'libern@someline.com', 'password' => 'Abc12345', ]); $restClient->withOAuthTokenTypeUser(); $response = $restClient->get("users")->getResponse(); if (!$restClient->isResponseStatusCode(200)) { $restClient->printResponseOriginContent(); $responseMessage = $restClient->getResponseMessage(); print_r($responseMessage); } else { $responseData = $restClient->getResponseData(); print_r($responseData); }
Testing
phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.