2017 © Pedro Peláez
 

library rest

REST Client and Server APIs for the XP Framework

image

xp-framework/rest

REST Client and Server APIs for the XP Framework

  • Thursday, November 16, 2017
  • by thekid
  • Repository
  • 2 Watchers
  • 1 Stars
  • 36,922 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 2 Forks
  • 2 Open issues
  • 34 Versions
  • 8 % Grown

The README.md

REST Client and Server APIs for the XP Framework

Build Status on TravisCI XP Framework Module BSD Licence Required PHP 5.6+ Supports PHP 7.0+ Required HHVM 3.4+ Latest Stable Version, (*1)

Client

Entry point

The Endpoint class serves as the entry point to this API. Create a new instance of it with the REST service's endpoint URL and then invoke its resource() method to work with the resources., (*2)

Creating: post

$api= new Endpoint('http://api.example.com/');
$response= $api->resource('users')->post(['name' => 'Test'], 'application/json');

// Check status codes
if (201 !== $response->status()) {
  throw new IllegalStateException('Could not create user!');
}

// Retrieve response headers
$url= $response->header('Location');

Reading: get / head

$api= new Endpoint('http://api.example.com/');

// Unmarshal to object by optionally passing a type; otherwise returned as map
$user= $api->resource('users/self')->get()->data(User::class);

// Test for existance with HEAD
$exists= (200 === $api->resource('users/1549')->head()->status());

// Pass parameters
$list= $api->resource('user')->get(['page' => 1, 'per_page' => 50])->data();

Updating: put / patch

$api= new Endpoint('http://api.example.com/');
$resource= $api->resource('users/self')
  ->using('application/json')
  ->accepting('application/json')
;

// Default content type and accept types set on resource used
$updated= $resource->put(['name' => 'Tested', 'login' => $mail])->data();

// Resources can be reused!
$updated= $resource->patch(['name' => 'Changed'])->data();

Deleting: delete

$api= new Endpoint('http://api.example.com/');

// Pass segments
$api->resource('user/{id}', ['id' => 6100])->delete();

Execute

If you need full control over the request, use the generic execute() method., (*3)

use webservices\rest\Endpoint;
use webservices\rest\RestRequest;
use peer\http\HttpConstants;

$api= new Endpoint('http://api.example.com/');

$request= (new RestRequest('/resource/{id}'))
 ->withMethod(HttpConstants::GET)
 ->withSegment('id', 5000)
 ->withParameter('details', 'true')
 ->withHeader('X-Binford', '6100 (more power)'
;

$response= $api->execute($request);
$content= $response->content();            // Raw data as string
$value= $response->data();                 // Deserialize to map

Deserialization

The REST API supports automatic result deserialization by passing a type to the data() method., (*4)

use com\example\api\types\Person;

$person= $response->data(Person::class);
$strings= $response->data('string[]');
$codes= $response->data('[:int]');

Authentication

Basic authentication is supported by embedding the credentials in the endpoint URL:, (*5)

use webservices\rest\Endpoint;

$api= new Endpoint('http://user:pass@api.example.com/');

The Versions

16/11 2017

dev-master

9999999-dev http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

16/11 2017

v9.1.0

9.1.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

24/09 2017

v9.0.1

9.0.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

20/06 2017

v9.0.0

9.0.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

20/05 2017

v8.3.3

8.3.3.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

16/01 2017

v8.3.2

8.3.2.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

16/01 2017

v8.3.1

8.3.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

13/10 2016

v8.3.0

8.3.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

13/10 2016

v8.2.1

8.2.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

29/09 2016

v8.2.0

8.2.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

27/09 2016

v8.1.1

8.1.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

26/09 2016

v8.1.0

8.1.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

17/09 2016

v8.0.1

8.0.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

04/09 2016

v8.0.0

8.0.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

29/08 2016

v7.3.2

7.3.2.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

28/08 2016

v7.3.1

7.3.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

28/08 2016

v7.3.0

7.3.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

03/07 2016

v7.2.1

7.2.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

08/06 2016

v7.2.0

7.2.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

01/05 2016

v7.1.0

7.1.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

25/04 2016

v7.0.3

7.0.3.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

21/04 2016

v7.0.2

7.0.2.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

18/03 2016

v7.0.1

7.0.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

21/02 2016

v7.0.0

7.0.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

24/01 2016

v6.4.2

6.4.2.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

24/01 2016

v6.4.1

6.4.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

20/12 2015

v6.4.0

6.4.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

module xp

27/09 2015

v6.3.1

6.3.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

module xp

23/08 2015

v6.3.0

6.3.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

module xp

12/07 2015

v6.2.1

6.2.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

module xp

13/06 2015

v6.2.0

6.2.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

module xp

01/06 2015

v6.1.0

6.1.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

module xp

12/02 2015

v6.0.1

6.0.1.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

module xp

11/01 2015

v6.0.0

6.0.0.0 http://xp-framework.net/

REST Client and Server APIs for the XP Framework

  Sources   Download

BSD-3-Clause

The Requires

 

module xp