2017 © Pedro Peláez
 

library wrapi

Wrapper for calling Restful API

image

palanik/wrapi

Wrapper for calling Restful API

  • Monday, January 22, 2018
  • by palanik
  • Repository
  • 1 Watchers
  • 1 Stars
  • 11,559 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 8 Versions
  • 25 % Grown

The README.md

wrapi

Wrapper for calling Restful API, (*1)

wrapi allows you to call HTTP based APIs just like making calls to ordinary php functions., (*2)

Latest Stable Version Build Status License, (*3)

Installation

Install with Composer

  1. Update your composer.json to require palanik/wrapi package.
  2. Run composer install to add wrapi your vendor folder.
{
  "require": {
    "palanik/wrapi": "*"
  }
}

or simply run, (*4)

composer require palanik/wrapi

Easy Start

Approach I

  1. Create an array listing all the API endpoints you want to work with.
  2. Wrap endpoints with wrapi.
  3. Call individual endpoints as functions.

See Example Code, (*5)

Approach II

  1. Create client object with API Base URL.
  2. Register API endpoints.
  3. Call individual endpoints as functions.

See Example Code, (*6)

Endpoints Array

Declare each endpoint as per the following specifications., (*7)

"function_name" => array(
    "method" => "HTTP_METHOD",                  // 'GET', 'POST', 'PUT', 'PATCH' or 'DELETE'
    "path" => "relative/path/to/:api/endpoint"  // Can use `Slim`/`express` style path params
)

eg. a small set of github.com API, (*8)

array(
    "repo" => array(
        "method" => "GET",
        "path" => "repos/:owner/:repo"
    ),

    "contributors" => array(
        "method" => "GET",
        "path" => "repos/:owner/:repo/contributors"
    ),

    "languages" => array(
        "method" => "GET",
        "path" => "repos/:owner/:repo/languages"
    ),

    "tags" => array(
        "method" => "GET",
        "path" => "repos/:owner/:repo/tags"
    ),

    "branches" => array(
        "method" => "GET",
        "path" => "repos/:owner/:repo/branches"
    )
)

Wrap endpoints

Create a API client object from wrapi. Provide the base url for the API and the endpoints array. wrapi will create a client object with all the necessary functions., (*9)

$endpoints = array(...);

$client = new wrapi\wrapi('https://api.github.com/',    // base url for the API
  endpoints                                         // your endpoints array
);

// client object contains functions to call the API

Register

Register additional API endpoints with the client object with a function name., (*10)

$client("zen", 
    array(
        "method" => "GET",
        "path" => "zen"
        )
    );

Make the call

Call the functions with arguments., (*11)

// This will make GET request to 'https://api.github.com/repos/guzzle/guzzle/contributors'
$contributors = $client->contributors('guzzle', 'guzzle');

$zenQuote = $client->zen();
echo "Today's quote: ". $zenQuote;

API

wrapi is an open ended framework and is not restricted any one or a set of public APIs. All APIs providing HTTP interface to access the endpoints can be wrapped by wrapi so that you can quickly build your client application., (*12)

Endpoint definition

method & path/url are required., (*13)

  • method - Any one of the HTTP methods
  • path - route path to API Endpoint. Supports express style path params
  • query - an associative array with name-value pairs. This is optional. Useful where resources are identified via query string parameters
  • url - fully qualified uri string to override. Useful when api calls connect to a different endpoints

Client object

The wrapi object conveniently provides the client interface to the API. Create it by calling new wrapi\wrapi()., (*14)

The constructor takes the following arguments:, (*15)

  1. baseURL - The base url for the API. eg. https://api.github.com/repos/guzzle/guzzle/contributors
  2. endpoints - The array listing the endpoints of the API. Provide an empty array or a partial list and register endpoints later.
  3. options - Optional parameter. wrapi uses Guzzle module to connect to API server. The options parameter is the same options parameter used in Guzzle``request.

Register function

Add endpoints to client object., (*16)

$client(function_name, endpoint_definition)
  1. function_name - Alias for the endpoint, also the name of the function to call.
  2. endpoint_definition - Array defining the endpoint.

Function calls

Call the API via the function in the client object. Arguments to the function depend on the API declaration in the endpoints array., (*17)

Provide the arguments in the following order:, (*18)

  1. named params in the url path of the endpoint. eg. $client->contributors('guzzle', 'guzzle') // guzzle (owner) & guzzle (repo) are path params
  2. querystring as an associative array with name-value pairs. eg. $client->contributors(array("since" => 364) // querystring ?since=364
  3. body - JSON content for POST or PUT methods. Skip this argument if not required.

Examples

In examples folder., (*19)

License

MIT, (*20)

The Versions

22/01 2018

dev-dev

dev-dev https://github.com/palanik/wrapi-php

Wrapper for calling Restful API

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar palanik

api function wrapper restful guzzle functions

22/01 2018

dev-master

9999999-dev https://github.com/palanik/wrapi-php

Wrapper for calling Restful API

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar palanik

api function wrapper restful guzzle functions

22/01 2018

v0.1.7

0.1.7.0 https://github.com/palanik/wrapi-php

Wrapper for calling Restful API

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar palanik

api function wrapper restful guzzle functions

01/05 2016

v0.1.6

0.1.6.0 https://github.com/palanik/wrapi-php

Wrapper for calling Restful API

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar palanik

api function wrapper restful guzzle functions

14/02 2016

v0.1.5

0.1.5.0 https://github.com/palanik/wrapi-php

Wrapper for calling Restful API

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar palanik

api function wrapper restful guzzle functions

29/11 2015

v0.1.4

0.1.4.0 https://github.com/palanik/wrapi-php

Wrapper for calling Restful API

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar palanik

api function wrapper restful guzzle functions

25/11 2015

v0.1.1

0.1.1.0 https://github.com/palanik/wrapi-php

Wrapper for calling Restful API

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar palanik

api function wrapper restful guzzle functions

20/11 2015

v0.1.0

0.1.0.0 https://github.com/palanik/wrapi-php

Wrapper for calling Restful API

  Sources   Download

MIT

The Requires

 

by Avatar palanik

api function wrapper restful guzzle functions