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

27.01.2011Presenter: Ole Marius Smestad

Ole Marius Smestad

Lead engineer for eZ Publish

oms@ez.no

@dotten

About me

Agenda

News and conceptual feature discussion

Agenda

What has been done

Agenda

What has been done

What is being delivered

Agenda

What has been done

How to put this work to use

Agenda

What has been done

How to put this work to use

A bit of code

A retrospective

eZ Publish API

PHP APIs should be

Simple

PHP APIs should be

Simple

Consistent

PHP APIs should be

Simple

Consistent

Predictable

PHP APIs should be

A clear relationship

PHP APIs should be

A clear relationship

Objects Tasks

Concepts

PHP APIs should be

Simple

Consistent

Predictable

PHP APIs should be

Simple

Consistent

Predictable

A stable point of reference

A retrospective

eZ Publish API

A retrospective

RESTREST

27.01.2011Presenter: Ole Marius Smestad 13

( )13mandag 31. januar 2011

REST as a core feature

HTTP is the carrier

dedicated front-controller

back to the mothership

REST setup

eZPREST reqest

eZ Publishweb-‐request

REST setup

eZPREST

mapping content into resources

Makes data availableMakes data available

Makes data reusableMakes data reusable

content is liberated

One point oh

Being released as a part of Matterhorn

One point oh

Focus on infrastructure and basics

One point oh

Making content accessible (in useful ways)

One point oh

Making content accessible (in useful ways)

Always adaptable

One point oh

Github repositories available today

One point oh – the fineprint

Wonʼt support full CRUD in 1.0

Waiting for additions to our PHP API to fully support this

Applies to built-in content resources

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

Key features

content resources

Key features

Getting node data

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

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

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)

Getting a specific field

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

Key features

Rendered view

Key features

Systematic URLs

Response groups

Other resources available

child lists

sorting

Extending the REST API

URI pattern

Extending REST

URI pattern

Prefix Provider VersionGET Host / / / / Call + params

Just a token to trigger your rewrite rule

ezpRestPrefixFilterInterface

URI pattern

Prefix Provider Version

URI pattern

Prefix

Provider Version

URI pattern

Prefix

Provider Version

URI pattern

Prefix

Provider

Version

URI pattern

Prefix

Provider

Version

URI pattern

Prefix

Provider

Version

Remember, remember

Prefix filter

Always knows

Current provider

Current parsed version value

Versioned API

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

Versioned API

makes the notion version a part of the routing decision

Version

Extending the interface

REST providers

Extending the interface

ezpRestProviderInterface

Extending the REST interface

Overview of hooks

27.01.2011Presenter: Ole Marius Smestad 47

Route setup 1

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

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

OAuth 2.0

Authentication

Basic auth

Other security related options

Require HTTPS (a requirement of OAuth)

Decide which auth filter to use

Summary

Comes with the next release

Summary

Gives access to existing content in a systematic way

Summary

Output of content can be tweaked

Summary

Is extendible through eZ Market extensions

Summary

API is versioned

Summary

API is versioned

Control of BC

Summary

API is versioned

Control of BC

Control of already rolled out API clients

Questions?

Possibility for more Q&A at the barcamp

The end

Thank you for listening

The end

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

legia legia ole ole

Marius Katiliškis

Marius Minea

WS-Security Anders Smestad. The Web Services A service WSDL SOAP Client/Consumer UDDI.

Organic Solar Cells Greg Smestad ( developed this experiment..

OLE 도큐먼트와 OLE 자동화 - delphi.borlandforum.comdelphi.borlandforum.com/impboard/attach/0000140111/Chapter27.pdf · OLE 도큐먼트와 OLE 자동화 컨트롤러 ... OLE2를

Marius Ghenea

Smestad Osa Fmb1 Fi O(Final)

Clinciu Marius

Marius petipa

Marius Schmidt

marius Striblea

Licenta Marius

GUÉRIDON DE JARDIN PLIANT MARIUS 70X70CM EN ALU ...GUÉRIDON DE JARDIN PLIANT MARIUS 70X70CM EN ALU - JAUNE REFERENCE : MARIUS-TB70-JAUNE Modèle MARIUS, table de jardin pliante carrée

Various materials for primary school teacher training Bjørn Smestad, Oslo University College bjorsme/prague.htm.

ÅRSMELDING 2017 - Kolvereid IL · Dermed står fortsatt Ole Marius Back sin løyperekord på 39:06 fra 2013 fortsatt. Årsmelding Skigruppa 2017 Side 5 . ... I januar 2018 ble det

Writing the Web / The Story of Fluffy Alon Levi Anders Smestad Dominic Metzger.

Prospekt for Smestad Panorama Funkis

Testprotokoll Marius

Marius Koller