The document discusses Representational State Transfer (REST) and its implementation in the eZ Publish content management system. It begins with an overview of REST principles like giving resources IDs, linking resources, using standard HTTP methods, and communicating statelessly. It then covers how eZ Publish 5 is built on Symfony and includes REST APIs for content creation, retrieval, updating and deletion across the system. The document concludes with a demonstration of making REST API calls to retrieve content from eZ Publish and manipulate it.

1. #REST #ezpublish #symfony #IPC13 #CMS #SOA #UX
A REST Layer on Top
of The World
Nicolas Pastorino | eZ Systems
VP Community & Online Marketing
@jeanvoye | nicolas.pastorino@ez.no
Contents: Courtesy of Damien Pobel

2. about:eZ

3. about:eZ
Enterprise Open-source since 1999
Creators of eZ Publish Platform
Global
Business: http://ez.no | Community: http://share.ez.no

4. about:eZ
Enterprise Open-source since 1999
Creators of eZ Publish Platform
Global
Business: http://ez.no | Community: http://share.ez.no
@eZSystems
http://google.com/+ezsystems
http://linkedin.com/company/16738
https://github.com/ezsystems

5. about:me

6. about:me
eZ Publish Community since 2005
Lead Community + Marketing at eZ
Content Management, Open-source, Mountaineering

7. about:me
eZ Publish Community since 2005
Lead Community + Marketing at eZ
Content Management, Open-source, Mountaineering
@jeanvoye
http://bit.ly/nicolas-on-gplus
http://fr.linkedin.com/in/nicolaspastorino/
https://github.com/nfrp

8. T
O
D
A
Y

9. Y
REST
A
eZ Publish
D
REST in eZ Publish
O
DEMO
T
REST for UX

10. REST
5

11. REST?
h"p://www.infoq.com/ar4cles/rest-­‐introduc4on
h"p://en.wikipedia.org/wiki/Representa4onal_State_Transfer

12. REST?
Set of principles that define how Web standards,
such as HTTP and URIs, are supposed to be used.
Give every “thing” an ID
Link things together (“HATEOAS”)
Use standard methods
Resources with multiple representations
Communicate statelessly
h"p://www.infoq.com/ar4cles/rest-­‐introduc4on
h"p://en.wikipedia.org/wiki/Representa4onal_State_Transfer

13. REST? (ctd)
h"p://www.infoq.com/ar4cles/rest-­‐introduc4on
h"p://en.wikipedia.org/wiki/Representa4onal_State_Transfer

14. REST? (ctd)
Key goals of REST include:
Scalability of component interactions
Generality of interfaces
Independent deployment of components
Intermediary components to reduce latency,
enforce security and encapsulate legacy systems
h"p://www.infoq.com/ar4cles/rest-­‐introduc4on
h"p://en.wikipedia.org/wiki/Representa4onal_State_Transfer

15. HTTP 1.1 Request - Anatomy

16. HTTP 1.1 Request - Anatomy
• HTTP verb / method : GET,POST,PUT,DELETE,
TRACE,OPTIONS,HEAD, ...

17. HTTP 1.1 Request - Anatomy
• HTTP verb / method : GET,POST,PUT,DELETE,
TRACE,OPTIONS,HEAD, ...
• ... or a custom verb: PATCH,COPY, ...

18. HTTP 1.1 Request - Anatomy
• HTTP verb / method : GET,POST,PUT,DELETE,
TRACE,OPTIONS,HEAD, ...
• ... or a custom verb: PATCH,COPY, ...
• Set of headers

19. HTTP 1.1 Request - Anatomy
• HTTP verb / method : GET,POST,PUT,DELETE,
TRACE,OPTIONS,HEAD, ...
• ... or a custom verb: PATCH,COPY, ...
• Set of headers
• A body in POST,PUT or custom verb requests

20. HTTP 1.1 Response - Anatomy

21. HTTP 1.1 Response - Anatomy
• Status code (by @stevelosh)

22. HTTP 1.1 Response - Anatomy
• Status code (by @stevelosh)
• 1XX: hold on

23. HTTP 1.1 Response - Anatomy
• Status code (by @stevelosh)
• 1XX: hold on
• 2XX: here you go

24. HTTP 1.1 Response - Anatomy
• Status code (by @stevelosh)
• 1XX: hold on
• 2XX: here you go
• 3XX: go away

25. HTTP 1.1 Response - Anatomy
• Status code (by @stevelosh)
• 1XX: hold on
• 2XX: here you go
• 3XX: go away
• 4XX: you f * * * * d up

26. HTTP 1.1 Response - Anatomy
• Status code (by @stevelosh)
• 1XX: hold on
• 2XX: here you go
• 3XX: go away
• 4XX: you f * * * * d up
• 5XX: I f * * * * d up

27. HTTP 1.1 Response - Anatomy
• Status code (by @stevelosh)
• 1XX: hold on
• 2XX: here you go
• 3XX: go away
• 4XX: you f * * * * d up
• 5XX: I f * * * * d up
• Set of headers

28. HTTP 1.1 Response - Anatomy
• Status code (by @stevelosh)
• 1XX: hold on
• 2XX: here you go
• 3XX: go away
• 4XX: you f * * * * d up
• 5XX: I f * * * * d up
• Set of headers
• A body depending on the response

29. eZ Publish
10

30. Standard
Symfony2 App.
(=app)

31. Standard
Symfony2 App.
(=app)
+
eZ Publish
bundles
(PHP & REST APIs
+ Legacy)
vendor/
ezsystems/
ezpublish-kernel

32. Standard
Symfony2 App.
(=app)
+
eZ Publish
bundles
(PHP & REST APIs
+ Legacy)
vendor/
ezsystems/
ezpublish-kernel
+
Full-blown
Back-office

33. THIS is eZ Publish 5
Standard
Symfony2 App.
(=app)
+
eZ Publish
bundles
(PHP & REST APIs
+ Legacy)
vendor/
ezsystems/
ezpublish-kernel
+
Full-blown
Back-office

34. REST in eZ Publish
12

35. REST API in eZ Publish
4.x

36. REST API in eZ Publish
• eZ Publish 4.x has a REST API
• Prefix /ezp/api/v1/
• Read only
• Very limited scope / incomplete
4.x

37. REST API in eZ Publish
5.x

38. REST API in eZ Publish
5.x

39. REST API in eZ Publish
•
•
•
Read / Write
•
•
•
•
5.x
Support Basic Auth and Session Auth
Prefix /ezp/api/v2/
Allows to handle almost everything in the repository
(Content, Location, Types, ...)
XML or JSON support in input and output
Hypermedia as the Engine of Application State (HATEOAS)
Specifications: http://j.mp/ezpublish-rest-spec

40. A REST Layer on top of
a world of Content

41. A REST Layer on top of
a world of Content

42. A REST Layer on top of
a world of Content
o/

43. DEMO
16

44. Demo Synopsis
•
•
•
Navigate to http://cp2013.9.loc/ then to http://cp2013.9.loc/Blog
Add Blog post from http://cp2013.9.loc/ezdemo_site_admin/Blog (Content: http://phpconference.com/2013/en/sessions/rest-layer-top-world )
REST: Request REST Root:
•
•
•
Explain all parameters, then run.
REST: Show children of Content root
•
•
chrome-extension://hgmloofddffdnphfgcellkdfbfbjeloo/RestClient.html#RequestPlace:projectEndpoint/1
chrome-extension://hgmloofddffdnphfgcellkdfbfbjeloo/RestClient.html#RequestPlace:projectEndpoint/2
REST: Show Location/Content/ContentInfo for one child (“Blog”)
•
•
•
•
chrome-extension://hgmloofddffdnphfgcellkdfbfbjeloo/RestClient.html#RequestPlace:projectEndpoint/3
chrome-extension://hgmloofddffdnphfgcellkdfbfbjeloo/RestClient.html#RequestPlace:projectEndpoint/5
REST: Show children of one child (“Blog”)
•
•
•
•
chrome-extension://hgmloofddffdnphfgcellkdfbfbjeloo/RestClient.html#RequestPlace:projectEndpoint/4
Edit Content, then reload.
Show children: chrome-extension://hgmloofddffdnphfgcellkdfbfbjeloo/RestClient.html#RequestPlace:projectEndpoint/8
Delete the previously created blog post: curl -u "admin:publish" -X DELETE http://cp2013.9.loc/api/ezp/v2/content/objects/<objectId>
Refresh children list: Show children: chrome-extension://hgmloofddffdnphfgcellkdfbfbjeloo/RestClient.html#RequestPlace:projectEndpoint/8
REST: Create an Image object
•
•
Show ContentType (ContentClass) in back-office: http://cp2013.9.loc/ezdemo_site_admin/class/view/27
Create image from command line
•
•
$> cdipc13
•
•
Publish object: curl -u "admin:publish" -X PUBLISH http://cp2013.9.loc/api/ezp/v2/content/objects/<object Id>/versions/1
$> curl -u "admin:publish" -i -H "Accept: application/json" -H "Content-Type: application/vnd.ez.api.ContentCreate+json" -X POST -d
@createimage.json http://cp2013.9.loc/api/ezp/v2/content/objects
Show image in the back-office: http://cp2013.9.loc/ezdemo_site_admin/eZ-Systems-logo-created-with-the-REST-API

45. REST for UX
18

46. REST API for more than
service-to-service: UX example

47. REST API for more than
service-to-service: UX example
• API REST as provider for ajax calls - data
• Initial page load (JS code, generating an
interface) - then Ajax+REST for navigation, data
retrieval,
• Total separation of functional UX and data
retrieval + back-end business logic.

48. REST API for more than
service-to-service: UX example

49. REST API for more than
service-to-service: UX example
• Tools
• JS lib, REST client: https://github.com/
ezsystems/ez-js-rest-client
• Reproduction of the public PHP API: exposing
services
• Relying on HATEOS, but simplifying usage of it

50. REST API for more than
service-to-service: UX example

51. REST API for more than
service-to-service: UX example
• Why?
• Easy to discover the REST API structure from a client
• BC support: no URL hard-coding, painless clientside, all existing projects relying on the API need not
be modified,
• Simplifies cache management (HTTP): easy to know
exactly which resource is to be expired after a
change in content repository.

56. Demo Synopsis
•
•
•
•
Navigate to http://cp2013.9.loc/summercamp/rest-test
Open Console > Network > Filter with “XHR” only
Reload page, and clear console
Click on “Details” for “Blog”
•
Inspect request in console:
•
•
•
•
show URL
In “Preview” subtab: show response, focus on “Content.Section”
--> Show next request (back to “Headers” subtab): Section
•
•
•
•
show”Accept” header value,
show”Accept” header value,
show URL
In “Preview” subtab: show response, focus on “Section.name”
--> Show next request (back to “Headers” subtab): Owner

57. Wrap-up
24

58. T
O
D
A
Y

59. Y
REST
A
eZ Publish
D
REST in eZ Publish
O
DEMO
T
REST for UX

60. Slides available soon at
http://slideshare.net/jeanvoye
@jeanvoye
http://bit.ly/nicolas-on-gplus
http://fr.linkedin.com/in/nicolaspastorino/
https://github.com/nfrp
eZ Publish Community http://share.ez.no
eZ Publish 5 Community Project
http://share.ez.no/download
https://github.com/ezsystems/ezpublish-community
eZ Systems & eZ Publish Platform Enterprise Edition
http://ez.no