Developer Manual 

Using TYPO3 Restler in our own extension (aka Exposing your own REST API) 

In order to offer a seamless integration of Restler in TYPO3, this extension offers the interface "AoeRestlerSystemRestlerConfigurationInterface".

With classes implementing the "ConfigurationInterface", it is possible to configure Restler:

• Restler configuration can be defined (eg. supported response format)
• API endpoints can be defined
• Authentication classes can be defined (to protect API endpoints against unauthorized access)

Steps:

1. Create new PHP-class, which implements this Interface:

Aoe\Restler\System\Restler\ConfigurationInterface

You can use this PHP-class as example

Aoe\RestlerExamples\System\Restler\Configuration

Inside your PHP-class, you can configure the Restler framework:

• add API classes to the Restler object
• add Authentication classes to Restler object
• configure all static properties of PHP classes, which belong to the Restler framework

2. Register your PHP-class in your TYPO3-Extension (in ext_localconf.php-File)

Any class that implements the "AoeRestlerSystemRestlerConfigurationInterface" interface, must be declared in your extension "ext_localconf.php" file.

// Add the configuration class (in Extension 'restler'):
// In that configuration class, we can:
// - configure the cache directory
// - enable the extbase DI container
// - enable the online API documentation (if enabled in extension-configuration)
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['restler']['restlerConfigurationClasses'][] = 'Aoe\\Restler\\System\\RestlerConfiguration';

This way the following will be achieved:

• each extension can define any number of Restler configuration classes.
• the Restler configuration classes will only be called when an API endpoint is called (has no side-effects on normal calls of TYPO3).

3. Check the Restler extension configuration if you need / want to add the extension to the list (basic.extensionsWithRequiredExtLocalConfFiles).
4. Flush the TYPO3 System Cache

Examples 

To reduce the quantity of documentation required to use Restler, we provide also an example extension called restler_examples available on TER. You can check first there how the endpoints work.

Also please refer to existing documentation regarding [Restler][RestlerHomepage].

Exposing Internal APIs 

Just as you make HTTP calls to your public endpoints, it is possible to declare internal endpoints which you can use in a similar way, but using PHP.

You can practically decouple various components by exposing an internal API which is accessible via HTTP just during development.

Example:

$this->restApiClient->executeRequest('GET', '/api/rest-api-client/internal_endpoint/cars/1')

For details examples please refer to the restler_examples extension.

[RestlerHomepage]: http://www.luracast.com/products/restler