eZ Publish Rest API

Next topic

Author	Message
Alexandre Henriet	Tuesday 02 August 2011 6:52:19 am Hi,I'm trying to use the eZ Publish REST API with eZ Publish version "ezpublish_community_project-2011.7" I don't want to extend the REST API, just to use "the initial set of resources exposed by the eZ Publish REST API " http://doc.ez.no/eZ-Publish/Technical-manual/4.5/Features/Rest-API/Resources When I go to http://myhost:myport/api/ezp/v1/content/node/80 (existing node), I get the traditional "An unexpected error has occurred. Please contact the webmaster." And in the log files :[ Aug 02 2011 15:38:48 ] Unexpected error, the message was : No routes are defined in the router. in /opt/app/ezpublish/htdocs/lib/ezc/MvcTools/src/router.php on line 77 Here is the related configuration: [System]PrefixFilterClass=ezpRestDefaultRegexpPrefixFilterApiPrefix=/api [ApiProvider]ProviderClass[]ProviderClass[auth]=ezpRestAuthProvider [DebugSettings]Debug=enabled [OutputSettings]RendererClass[xhtml]=ezpContentXHTMLRenderer [ezpRestContentController_viewContent_OutputSettings]Template=rest_pagelayout.tpl [CacheSettings]# Global switch to enable/disable REST application cacheApplicationCache=enabled ... [Authentication]RequireAuthentication=enabled# AuthenticationStyle=ezpRestOauthAuthenticationStyleAuthenticationStyle=ezpRestBasicAuthStyleRequireHTTPS=disabled# Default user to authenticate when authentication is disabled or the route used doesn't need authentication# If left empty, site.ini/[UserSettings].AnonymousUserID will be usedDefaultUserID= ... [RouteSettings]RouteSettingImpl=ezpRestIniRouteFilter# Pattern for the skip filter# SkipFilter[]=controller_action;version# If the version component is not listed version "1" is assumed.SkipFilter[]SkipFilter[]=ezpRestErrorController_showSkipFilter[]=ezpRestAuthController_basicAuthSkipFilter[]=ezpRestAuthController_oauthRequiredSkipFilter[]=ezpRestOauthTokenController_handleRequest# Skip (auth) filter for every action in 'myController' which is of API version 2#SkipFilter[]=myController_*;2 Am I missing something ? Thanks in advance,Alex
Alexandre Henriet	Wednesday 03 August 2011 12:54:47 am Ok, I finally solved my problem thanks to : http://share.ez.no/forums/developer/trying-rest-api-but-keep-getting-provider-ezp-not-found As I'm not the first one to meet the problem, it might be useful to mention in the documentation that an extension is still required to use the REST API despite the core functionality is integrated in the kernel.

Author

Message

Tuesday 02 August 2011 6:52:19 am

Hi,I'm trying to use the eZ Publish REST API with eZ Publish version
"ezpublish_community_project-2011.7"

I don't want to extend the REST API, just to use "the initial set of resources exposed by the eZ Publish REST API " http://doc.ez.no/eZ-Publish/Technical-manual/4.5/Features/Rest-API/Resources

When I go to http://myhost:myport/api/ezp/v1/content/node/80 (existing node), I get the traditional
"An unexpected error has occurred. Please contact the webmaster."

And in the log files :[ Aug 02 2011 15:38:48 ] Unexpected error, the message was : No routes are defined in the router. in /opt/app/ezpublish/htdocs/lib/ezc/MvcTools/src/router.php on line 77

Here is the related configuration:

[System]PrefixFilterClass=ezpRestDefaultRegexpPrefixFilterApiPrefix=/api
[ApiProvider]ProviderClass[]ProviderClass[auth]=ezpRestAuthProvider
[DebugSettings]Debug=enabled
[OutputSettings]RendererClass[xhtml]=ezpContentXHTMLRenderer
[ezpRestContentController_viewContent_OutputSettings]Template=rest_pagelayout.tpl
[CacheSettings]# Global switch to enable/disable REST application cacheApplicationCache=enabled

...

[Authentication]RequireAuthentication=enabled# AuthenticationStyle=ezpRestOauthAuthenticationStyleAuthenticationStyle=ezpRestBasicAuthStyleRequireHTTPS=disabled# Default user to authenticate when authentication is disabled or the route used doesn't need authentication# If left empty, site.ini/[UserSettings].AnonymousUserID will be usedDefaultUserID=

...

[RouteSettings]RouteSettingImpl=ezpRestIniRouteFilter# Pattern for the skip filter# SkipFilter[]=controller_action;version# If the version component is not listed version "1" is assumed.SkipFilter[]SkipFilter[]=ezpRestErrorController_showSkipFilter[]=ezpRestAuthController_basicAuthSkipFilter[]=ezpRestAuthController_oauthRequiredSkipFilter[]=ezpRestOauthTokenController_handleRequest# Skip (auth) filter for every action in 'myController' which is of API version 2#SkipFilter[]=myController_*;2

Am I missing something ?

Thanks in advance,Alex

Alexandre Henriet

Wednesday 03 August 2011 12:54:47 am

Ok, I finally solved my problem thanks to : http://share.ez.no/forums/developer/trying-rest-api-but-keep-getting-provider-ezp-not-found

As I'm not the first one to meet the problem, it might be useful to mention in the documentation that an extension is still required to use the REST API despite the core functionality is integrated in the kernel.

eZ debug

Timing:	Feb 03 2025 02:12:40
Script start
Timing:	Feb 03 2025 02:12:40
Module start 'layout'
Timing:	Feb 03 2025 02:12:40
Module start 'content'
Timing:	Feb 03 2025 02:12:40
Module end 'content'
Timing:	Feb 03 2025 02:12:40
Script end

Main resources:

Total runtime	0.5109 sec
Peak memory usage	4,096.0000 KB
Database Queries	54

Timing points:

Checkpoint	Start (sec)	Duration (sec)	Memory at start (KB)	Memory used (KB)
Script start	0.0000	0.0048	588.0078	152.6094
Module start 'layout'	0.0048	0.0042	740.6172	216.0938
Module start 'content'	0.0091	0.5003	956.7109	959.3281
Module end 'content'	0.5093	0.0016	1,916.0391	8.1875
Script end	0.5109		1,924.2266

Time accumulators:

Accumulator	Duration (sec)	Duration (%)	Count	Average (sec)
Ini load
Load cache	0.0040	0.7902	16	0.0003
Check MTime	0.0020	0.3876	16	0.0001
Mysql Total
Database connection	0.0007	0.1284	1	0.0007
Mysqli_queries	0.4614	90.2996	54	0.0085
Looping result	0.0003	0.0580	52	0.0000
Template Total	0.4809	94.1	2	0.2404
Template load	0.0023	0.4488	2	0.0011
Template processing	0.4786	93.6681	2	0.2393
Template load and register function	0.0011	0.2204	1	0.0011
states
state_id_array	0.0009	0.1847	1	0.0009
state_identifier_array	0.0006	0.1233	2	0.0003
Override
Cache load	0.0019	0.3808	28	0.0001
Sytem overhead
Fetch class attribute can translate value	0.0003	0.0660	1	0.0003
Fetch class attribute name	0.0017	0.3273	2	0.0008
XML
Image XML parsing	0.0001	0.0176	1	0.0001
class_abstraction
Instantiating content class attribute	0.0000	0.0010	2	0.0000
General
dbfile	0.0008	0.1591	10	0.0001
String conversion	0.0000	0.0016	4	0.0000
Note: percentages do not add up to 100% because some accumulators overlap

Templates used to render the page:

Usage	Requested template	Template	Template loaded
1	node/view/full.tpl	full/forum_topic.tpl	extension/sevenx/design/simple/override/templates/full/forum_topic.tpl
2	content/datatype/view/ezxmltext.tpl	<No override>	extension/community_design/design/suncana/templates/content/datatype/view/ezxmltext.tpl
3	content/datatype/view/ezxmltags/line.tpl	<No override>	design/standard/templates/content/datatype/view/ezxmltags/line.tpl
5	content/datatype/view/ezxmltags/paragraph.tpl	<No override>	extension/ezwebin/design/ezwebin/templates/content/datatype/view/ezxmltags/paragraph.tpl
2	content/datatype/view/ezxmltags/link.tpl	<No override>	design/standard/templates/content/datatype/view/ezxmltags/link.tpl
1	print_pagelayout.tpl	<No override>	extension/community/design/community/templates/print_pagelayout.tpl
Number of times templates used: 14 Number of unique templates used: 6

Time used to render debug report: 0.0001 secs