shamanzpua/apirequest

base for api requests

2.1 2017-02-28 20:22 UTC

Requires

• guzzlehttp/guzzle: ^6.2

BSD-3-Clause

• shamanzp

• curl
• http
• api
• request

README

Template for different api requests.

Installation

Add to composer.json

 "require": {
    "shamanzpua/apirequest": "*"
 }

Usage

Create new custom class Builder:

<?php

namespace components\request\builders;

use shamanzpua\apirequest\builders\BuilderStrategyInterface;
use shamanzpua\apirequest\builders\AbstractRequestBuilder;

/**
 * Class for building request for example api
 */
class ExampleBuilder extends AbstractRequestBuilder implements BuilderStrategyInterface
{
    const ALLOWED_METHODS = ['GET'];

    protected $api = "/example";


    /**
     * Allowed params for query
     */
    public function getAllowedQueryParams()
    {
        return array_merge(
            parent::getAllowedQueryParams(),
            [
                'q' => [],
            ]
        );
    }

    /**
     * Build request
     */
    public function build()
    {
        if (!empty($this->queryParams)) {
            $this->query = "?". http_build_query($this->queryParams);
        }
        $this->query = $this->baseUrl.$this->api. $this->query;
    }
}

Use in code:

<?php

use shamanzpua\apirequest\RequestConfig;
use shamanzpua\apirequest\Request;
use shamanzpua\apirequest\builders\ContextRequestBuilder;
use shamanzpua\apirequest\Api;
use components\request\builders\ExampleBuilder;

/**
 * Example api class
 */
class ExampleApi extends Api
{
    /**
     * Api baseurl
     */
    protected $apiBaseUrl = 'https://api.example.com';

    /**
     * Configure, build and send request to example api
     */
    public function apiExample($search)
    {
        $queryParams = [
            'q' => $search,
        ];

        $requestConfig = $this->createConfigurator(RequestConfig::class);
        $requestConfig->setHttpMethod(RequestConfig::HTTP_METHOD_GET)
            ->setQueryParams($queryParams);

        $request = new Request(
            new ContextRequestBuilder(new ExampleBuilder($requestConfig))
        );
        return $request->send()->getResonseData();
    }
}