php-extended/php-api-endpoint-http-object

An implementation of the php-extended/php-api-endpoint-http-interface library

4.0.0 2022-05-31 08:45 UTC

Requires

• php: >=7.2
• php-extended/php-api-endpoint-http-interface: ^4
• php-extended/php-api-endpoint-object: ^4
• php-extended/php-http-message-factory-psr17: ^4
• php-extended/polyfill-php80-stringable: ^1

Requires (Dev)

• php-extended/placeholder-phpunit: >=1

MIT

• Anastaszor

• php
• http
• api
• object
• implementation
• endpoint

README

An implementation of the php-extended/php-api-endpoint-http-interface library.

Installation

The installation of this library is made via composer. Download composer.phar from their website. Then add to your composer.json :

	"require": {
		...
		"php-extended/php-api-endpoint-http-object": "^3"
		...
	}

Then run php composer.phar update to install this library. The autoloading of all classes of this library is made through composer's autoloader.

Basic Usage

This library is made to be extended. The HttpEndpoint implementation is a generic object that is made to ease the transform into a really useful endpoint that may be something like

use PhpExtended\Endpoint\Endpoint;

class MyEndpoint extends HttpEndpoint
{

	public function getFoo() : Foo
	{
		$stringData = $this->httpGet($this->createUri('https://example.com'));
		return $this->getObject(Foo::class, new CustomDataProvider($stringData));
	}

}

Where getDataProvider() is a method that returns a data provider that get raw data, either from a file (csv, json, yaml, etc.) or network (json api, rest api, xml, parsed html, etc, even semantic formats..)

License

MIT (See license file).