Ole marius smestad - REST & PHP API : how to turn eZ Publish into a multi-channel machine

eZ Winter Conference 2011, Nice

REST & PHP API

1mandag 31. januar 2011

Introduction

2


27.01.2011Presenter: Ole Marius Smestad

Ole Marius Smestad

Lead engineer for eZ Publish

[email protected]

@dotten

3

About me


mailto:[email protected]

mailto:[email protected]


Agenda

4



Agenda

News and conceptual feature discussion

4



Agenda


What has been done

4



Agenda


What has been done

What is being delivered

4



Agenda


What has been done


How to put this work to use

4



Agenda


What has been done


How to put this work to use

A bit of code

4


5

A retrospective



A retrospective

6

APIs



A retrospective

7

PHP

REST

eZ Publish API



PHP APIs should be

8

Simple



PHP APIs should be

8

Simple

Consistent



PHP APIs should be

8

Simple

Consistent

Predictable



PHP APIs should be

A clear relationship

9



PHP APIs should be

A clear relationship

9

Objects Tasks

Concepts



PHP APIs should be

10

Simple

Consistent

Predictable



PHP APIs should be

10

Simple

Consistent

Predictable

A stable point of reference



A retrospective

11

PHP

REST

eZ Publish API



A retrospective

12

REST



A retrospective

12

RESTREST


27.01.2011Presenter: Ole Marius Smestad 13

( )13mandag 31. januar 2011


REST

REST as a core feature

14



REST

HTTP is the carrier

15



REST

dedicated front-controller

16



REST

back to the mothership

17



REST

18

REST setup

REST

FC

eZPREST reqest

eZ Publishweb-‐request



REST

19

REST setup

eZPREST

FC



REST

20

mapping content into resources



REST

21

Makes data availableMakes data available



REST

21

Makes data reusableMakes data reusable



REST

22

content is liberated


One point oh

23



One point oh

24



One point oh

24

Being released as a part of Matterhorn



One point oh

24


Focus on infrastructure and basics



One point oh

24



Making content accessible (in useful ways)



One point oh

24



Making content accessible (in useful ways)

Always adaptable



One point oh

Github repositories available today

25



One point oh – the fineprint

26




Wonʼt support full CRUD in 1.0

26





Waiting for additions to our PHP API to fully support this

26






Applies to built-in content resources

26






Applies to built-in content resources

REST extensions will be able to provide all operations from day one

26


Key features

27



content resources

28

Key features



Getting node data

GET /[api]/ezp/v1/content/⤦node/<ID> HTTP/1.1

29



Getting node data

30



Getting node data

classIdentifier

objectName

datePublished

dateModified

remoteID

objectRemoteID

nodeID

objectID

Full URL, etc.30



Getting fields

GET /[api]/ezp/v1/content/⤦object/<objectId>/fields⤦

HTTP/1.1

31



Getting fields

fields/<fieldname>

type (datatype string)

identifier (attribute identifier)

value (string representation of data)

id (object attribute numerical ID)

classattribute_id (class attribute numerical ID)

32



Getting a specific field

GET /[api]/ezp/v1/content/⤦object/<objectId>/field/⤦<FieldIdentifier> HTTP/1.1

33



Key features

Rendered view

34



Key features

Systematic URLs

Response groups

Other resources available

child lists

sorting

35


Extending the REST API

36



URI pattern

37

Extending REST



URI pattern

38

Prefix Provider VersionGET Host / / / / Call + params

Just a token to trigger your rewrite rule

ezpRestPrefixFilterInterface



URI pattern

38

Prefix Provider Version





URI pattern

38

Prefix

Provider Version





URI pattern

38

Prefix

Provider

Version





Remember, remember

39




Prefix filter

40

Always knows

Current provider

Current parsed version value



Versioned API

41

class ezpRestRouter extends ezcMvcRouter{ public function createRoutes() { // ezpRestApiProvider $routes = array( new ezcMvcRailsRoute( '/content/node/:nodeId/listAtom', 'ezpRestAtomController', 'collection' ), new ezcMvcRailsRoute( '/content/node/:nodeId/list', 'ezpRestContentController', 'list' ), new ezcMvcRailsRoute( '/content/node/:nodeId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/node/:nodeId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/node/:nodeId/field/:fieldIdentifier', 'ezpRestContentController', 'viewField' ), new ezcMvcRailsRoute( '/content/object/:objectId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/object/:objectId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/object/:objectId/field/:fieldIdentifier', 'ezpRestContentController', 'viewField' ),

new ezpRestVersionedRoute( new ezcMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezcMvcRailsRoute( 'e/foo', 'myController2 or myControlerWhichExtendsmyController', 'myBetterAndScalingAction' ), 2 ), ); return ezcMvcRouter::prefix( '/api', $routes ); }}



Versioned API

ezpRestVersionedRoute

42



Versioned API

makes the notion version a part of the routing decision

43

Version



Extending the interface

44

REST providers



Extending the interface

ezpRestProviderInterface

45



Extending the REST interface

Overview of hooks

46


27.01.2011Presenter: Ole Marius Smestad 47



Route setup 1

48

class ezpRestRouter extends ezcMvcRouter{ public function createRoutes() { // ezpRestApiProvider $routes = array( new ezcMvcRailsRoute( '/content/node/:nodeId/listAtom', 'ezpRestAtomController', 'collection' ), new ezcMvcRailsRoute( '/content/node/:nodeId/list', 'ezpRestContentController', 'list' ), new ezcMvcRailsRoute( '/content/node/:nodeId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/node/:nodeId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/node/:nodeId/field/:fieldIdentifier', 'ezpRestContentController', 'viewField' ), new ezcMvcRailsRoute( '/content/object/:objectId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/object/:objectId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/object/:objectId/field/:fieldIdentifier', 'ezpRestContentController', 'viewField' ),

new ezpRestVersionedRoute( new ezcMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezcMvcRailsRoute( 'e/foo', 'myController2 or myControlerWhichExtendsmyController', 'myBetterAndScalingAction' ), 2 ), ); return ezcMvcRouter::prefix( '/api', $routes ); }}



Route setup 2

49

class ezpRestRouter extends ezcMvcRouter{ public function createRoutes() { $providerRoutes = ezpRestProvider::getProvider( ezpRestPrefixFilterInterface::getApiProviderName() )->getRoutes();

$routes = array( new ezpMvcRailsRoute( '/fatal', 'ezpRestErrorController', 'show' ), new ezpMvcRailsRoute( '/http-basic-auth', 'ezpRestAuthController', 'basicAuth' ), new ezpMvcRailsRoute( '/login/oauth', 'ezpRestAuthController', 'oauthRequired' ), new ezpMvcRailsRoute( '/oauth/token', 'ezpRestOauthTokenController', 'handleRequest'),

// ezpRestVersionedRoute( $route, $version ) // $version == 1 should be the same as if the only the $route had been present new ezpRestVersionedRoute( new ezpMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezpMvcRailsRoute( '/foo', 'myController', 'myActionOneBetter' ), 2 ),

);

return ezcMvcRouter::prefix( '/api', array_merge( $providerRoutes, $routes ) ); }}


Protecting your resources

50



OAuth 2.0

51

Authentication



Authentication

Basic auth

52



Other security related options

Require HTTPS (a requirement of OAuth)

Decide which auth filter to use

53


Summary

54



Summary

55



Summary

Comes with the next release

55



Summary


Gives access to existing content in a systematic way

55



Summary



Output of content can be tweaked

55



Summary




Is extendible through eZ Market extensions

55



Summary





API is versioned

55



Summary





API is versioned

Control of BC

55



Summary





API is versioned

Control of BC

Control of already rolled out API clients

55



Questions?

56



Possibility for more Q&A at the barcamp

57



The end

58

Thank you for listening



The end

59

github.com/ezsystems/ezp_rest


Ole marius smestad - REST & PHP API : how to turn eZ Publish into a multi-channel machine

Technology

Transcript of Ole marius smestad - REST & PHP API : how to turn eZ Publish into a multi-channel machine