.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _developer:

Developer Corner
================

Target group: **Developers**

This section shows you, how to define a webservice with this extension.


.. _developer-api:

API
---

First of all create a class and add the annotation @Path. The leading slash is mandatory.

.. code-block:: php

    /*
     * @Path /myservice
     */
     class MyFirstWebservice {
     }

Next, create a method which should be called and add the annotation @Path and the required HTTP request
method (@GET or @POST) as annotation.

.. code-block:: php

    /**
     * @GET
     * @Path /users/{param}
     */
    public function usersMethod($param) {
        print_r($param);
    }

In your ex_localconf.php register your class as a webservice.

.. code-block:: php

    $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['bdegmbh_webservices']['services'][]
		= 'EXT:'.$_EXTKEY.'/Classes/MyFirstWebservice.php:MyFirstWebservice';

That's all. Open the url <Your-Typo3-environment>/services/myservice/users/dummy and you should see the word
dummy in your browser.