Path

ez.no / documentation / ez publish / technical manual / 4.6 / features / rest api / rest api configuration sett...


You are now viewing the documentation of eZ Publish legacy (4.x series and the legacy "stack" in 5.x). For 5.x versions this documentation must be complemented with the latest, more current documentation available at confluence.ez.no. Happy learning!

REST API configuration settings

Please read on below to find an overview of the INI settings currently existing in the REST API layer:

System settings

[System]
PrefixFilterClass=ezpRestDefaultRegexpPrefixFilter
ApiPrefix=/api

API provider

[ApiProvider]
ProviderClass[]

Debug settings

[DebugSettings]
Debug=disabled

Output settings

[OutputSettings]
RendererClass[xhtml]=ezpContentXHTMLRenderer
 
[ezpRestContentController_viewContent_OutputSettings]
Template=rest_pagelayout.tpl

Cache settings

[CacheSettings]
# Global switch to enable/disable REST application cache
ApplicationCache=enabled

The ApplicationCache is set to "Enabled" as the default value if no specific value has been defined for your controller/action. If the Application cache is set to enabled the result of each service call will be cached. You can refine this with setting specific to your controller/action. The system will look for a [<controllerClass>_<action>_CacheSettings] block to check if cache can be used, and if so, which TTL to use. If this block cannot be found, the system will search at the controller level, and so look for a [<controllerClass>_CacheSettings] block.

See example block below for more information

# Basically this setting allows you to activate the cache to your controllers/actions individually
ApplicationCacheDefault=enabled
 
# Set default TTL to 10min, in seconds
DefaultCacheTTL=600
 
# Example for action "viewContent", in "ezpRestContentController" controller class
#[ezpRestContentController_viewContent_CacheSettings]
#ApplicationCache=enabled
#CacheTTL=3600
 
# Below an example for every action contained in "ezpRestContentController" controller class
#[ezpRestContentController_CacheSettings]
#ApplicationCache=enabled
#CacheTTL=1200
 
# Switch to enable/disable Routes cache with APC
RouteApcCache=enabled
# TTL for Route APC cache, in seconds
RouteApcCacheTTL=3600

Authentication

[Authentication]
RequireAuthentication=enabled
AuthenticationStyle=ezpRestOauthAuthenticationStyle
#AuthenticationStyle=ezpRestBasicAuthStyle
RequireHTTPS=disabled

Route settings

[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_show
SkipFilter[]=ezpRestAuthController_basicAuth
SkipFilter[]=ezpRestAuthController_oauthRequired
SkipFilter[]=ezpRestOauthTokenController_handleRequest
# Skip (auth) filter for every action in 'myController' which is of API version 2
SkipFilter[]=myController_*;2

Geir Arne Waaler (08/02/2011 10:49 am)

Geir Arne Waaler (13/04/2011 11:21 am)


Comments

There are no comments.