bajzany/api-client

There is no license information available for the latest version (v1.0.6) of this package.

Api client for Nette Framework

v1.0.6 2020-01-09 10:15 UTC

Requires

• php: ^7.2
• jms/serializer: ^3.2
• nette/application: ^2.4
• nette/di: ^2.4

Unknown License

• Radek Zíka

• apiclient

README

Instalation

• Composer instalation

composer require bajzany/api-client dev-master

• Register into Nette Application

extensions:
	ApiClientExtension: Bajzany\ApiClient\DI\ApiClientExtension
	
ApiClientExtension: 
	verify: TRUE
	stream: TRUE
	connect_timeout: 20
	read_timeout: 20
	timeout: 20

• verify = enable validate certificate
• connect_timeout = Float describing the number of seconds to wait while trying to connect to a server. Use 0 to wait indefinitely (the default behavior).
• timeout = Timeout if a server does not return a response
• read_timeout = The timeout applies to individual read operations on a streamed body (when the stream option is enabled).

How to use

• first create api request action class witch extended Bajzany\ApiClient\Model\EndPoint like Bajzany\ApiClient\Example\UpdateUserApi

   <?php
   
   namespace Bajzany\ApiClient\Example;
   
   use Bajzany\ApiClient\Model\EndPoint;
   use Bajzany\ApiClient\Provider;
   use Bajzany\ApiClient\Response;
   
   class UpdateUserApi extends EndPoint
   {
   
   	const METHOD = Provider::METHOD_POST;
   
   	/**
   	 * @var int
   	 */
   	private $userId;
   
   	/**
   	 * @var array
   	 */
   	private $data;
   
   	public function __construct(int $userId, array $data)
   	{
   		$this->userId = $userId;
   		$this->data = $data;
   	}
   
   	/**
   	 * @return string
   	 */
   	public function getUrl(): string
   	{
   		return "http://crm.d/test/user-update/{$this->userId}";
   	}
   
   	/**
   	 * @param Provider $provider
   	 * @return mixed
   	 * @internal
   	 */
   	public function processRawRequest(Provider $provider): array
   	{
   		return $this->data;
   	}
   
   	/**
   	 * @param Provider $provider
   	 * @return Response|mixed
   	 * @throws \GuzzleHttp\Exception\GuzzleException
   	 */
   	public function execute(Provider $provider)
   	{
   		return parent::execute($provider);
   	}
   }

  • const METHOD set request method etc ('POST', 'GET', 'PUT', 'DELETE')
  • function getUrl set request url
  • function processRawRequest pass into request body data
  • function execute can be replace own execute events

• For run this action must be injected service Bajzany\ApiClient\Provider

   /** @var Provider @inject */
   public $provider;

• Now you can run this action like this:

   $updateUserApi = new UpdateUserApi($userId, [$myData]);
   $response = $updateUserApi->execute($this->provider);	

• Into provider can be place events in request and response has been created

   $this->provider->onRequest[] = function (Provider $provider, EndPoint $endPoint, $response) {
   	.....
   };
   $this->provider->onResponse[] = function (Provider $provider, EndPoint $endPoint, $response) {
   	.....
   };