fenzland/http-api-gluer

0.2.0 2018-03-26 07:56 UTC

Requires

• php: >=7.1.0
• fenzland/data-parser: ^0.1.0
• fenzland/http: ^0.1.13

MIT

• Fenz

README

A library for calling HTTP API, and avoid hard code about details of specific API.

Usage

composer require fenzland/http-api-gluer

Create instance of Gluer.

use Fenzland\HttpApiGluer\Gluer;
use Fenzland\DataParser\Transformer;

$gluer= new Gluer(
	'https://url'           // URL of API.
,
	'POST'                  // Method of API.
,
	$request_transformer    // instance of Transformer.
,
	$response_transformer   // instance of Transformer.
,
	'application/json'      // content type of request
,
	'application/json'      // content type of response (optional if same with content type of request)
);

// or

$gluer= Gluer::make_(
	'https://url/{path_param}'
,
	'POST'
,
	$request_transformer_meta    // meta array of Transformer.
,
	$response_transformer_meta   // meta array of Transformer.
,
	'application/json'
);

Call api.

$result= $gluer->call( $data );

Account Types

Built-in supported

• application/octet-stream
• application/php-serialized
• application/json
• application/x-www-form-urlencoded

Extending

use Fenzland\HttpApiGluer\serializers\ASerializer

class CustomSerializer extends ASerializer
{
	public function encode( $data ):string
	{
		# ...
	}

	public function decode( string$encoded )
	{
		# ...
	}
}

Gluer::registerSerializer_( 'custom/mime', CustomSerializer::class );
// or
Gluer::registerSerializer_( 'custom/mime', new CustomSerializer );

About Transformer

Preliminary: fenzland/data-parser

Request Transformer

[
	'path'=> ...,     // parameters in path example: https://github.com/{name}/{repo}
	'query'=> ...,    // parameters in url query example: ?key0=value0&key1=value1
	'headers'=> ...,  // parameters in header
	'body'=> ...,     // parameters or data in body
];

Response Transformer

[
	"foo_in_header"=> [
		'type'=> 'value',
		'keys'=> [ 'headers', "foo", ],
	],
	"bar_in_body"=> [
		'type'=> 'value',
		'keys'=> [ 'body', "bar", "baz", ],
	],
];