Changes between Version 50 and Version 51 of RESTController


Ignore:
Timestamp:
08/22/10 18:16:49 (11 years ago)
Author:
Dominic König
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • RESTController

    v50 v51  
    33= REST Controller =
    44
    5 '''[wiki:S3REST]''' provides a generic '''RESTful API''' ([http://en.wikipedia.org/wiki/Representational_State_Transfer Representational State Transfer]) for Sahana Eden database resources, i.e. it can map HTTP requests to data resources and function calls. In particular, it maps resource addresses (=URL's) and HTTP methods (=GET, PUT, DELETE etc.) to CRUD actions, and then invokes so called ''method handlers'' (provided by the calling controller via hooks) to execute those actions (important: S3REST itself does not manipulate any data!).
    6 
    7 The so called '''REST Controller''' (function ''shn_rest_controller()'') is a wrapper function for [wiki:S3REST], which provides generic CRUD method handlers. These method handlers as well as the REST controller itself are implemented in {{{models/01_crud.py}}}.
     5[wiki:S3XRC_S3Resource S3Resource]s provide a generic '''RESTful API''' ([http://en.wikipedia.org/wiki/Representational_State_Transfer Representational State Transfer]) for Sahana Eden database resources, i.e. they can map HTTP requests to data resources and function calls.
     6
     7In particular, they map resource addresses (=URL's) and HTTP methods (=GET, PUT, DELETE etc.) to CRUD actions, and then invoke so called ''method handlers'' (provided by the calling controller via hooks) to execute those actions.
     8
     9The so called '''REST Controller''' (function ''shn_rest_controller()'') is a wrapper function for the S3Resource REST interface, which provides generic CRUD method handlers. These method handlers as well as the REST controller itself are implemented in {{{models/01_crud.py}}}.
    810
    911The method handlers support a number of data representation formats:
     
    1315    * XLS (export only)
    1416    * CSV
    15     * [wiki:S3XRC XML] using in-line XSLT transformation to support various XML formats
    16     * [wiki:S3XRC JSON] as light-weight alternative for AJAX-style resource access
    17 
    18 See also: [wiki:S3REST S3REST], [wiki:S3XRC S3XRC], [wiki:DeveloperGuidelinesRESTCustomisation REST Customisation]
     17
     18See also: [wiki:S3XRC S3XRC], [wiki:DeveloperGuidelinesRESTCustomisation REST Customisation]
    1919
    2020A good tool for testing the REST functionality is the [http://code.google.com/p/rest-client/ RESTClient]
     21
    2122== Resources ==
    2223
     
    3031
    3132Resources as well as their components and methods can be addressed individually by URL's.
     33
    3234== URL Argument Lists ==
    3335