Changes between Version 76 and Version 77 of RESTController


Ignore:
Timestamp:
06/04/13 06:09:41 (11 years ago)
Author:
Pat Tressel
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • RESTController

    v76 v77  
    77== Introduction ==
    88
    9 The so called '''REST Controller''' (function {{{s3_rest_controller()}}}) is a wrapper function for the RESTful API of the [wiki:S3XRC_S3Resource S3Resource] class.
    10 
    11 The [wiki:S3XRC_S3Resource S3Resource] class implements a generic '''RESTful API''' ([http://en.wikipedia.org/wiki/Representational_State_Transfer Representational State Transfer]) for Sahana Eden database resources, which maps HTTP requests (i.e., URLs and HTTP methods like GET, PUT, DELETE etc.) to internal data stores (e.g. database resources) and methods (e.g. CRUD), and applies the methods by calling so called ''method handlers''.
     9The so called '''REST Controller''' (function {{{s3_rest_controller()}}}) is a wrapper function for the RESTful API of the [wiki:S3XRC/RESTfulAPI/S3Resource S3Resource] class.
     10
     11The [wiki:S3XRC/RESTfulAPI/S3Resource S3Resource] class implements a generic '''RESTful API''' ([http://en.wikipedia.org/wiki/Representational_State_Transfer Representational State Transfer]) for Sahana Eden database resources, which maps HTTP requests (i.e., URLs and HTTP methods like GET, PUT, DELETE etc.) to internal data stores (e.g. database resources) and methods (e.g. CRUD), and applies the methods by calling so called ''method handlers''.
    1212
    1313Method handlers are to be provided by the calling controller via hooks. The function {{{s3_rest_controller()}}} simplifies the use of the REST interface and provides a number of pre-configured standard CRUD method handlers.
    … …  
    1717
    1818The method handlers of {{{s3crud.py}}} support a number of data representation formats:
    19 * HTML (including autogenerated Create/Update forms)
     19* HTML (including autogenerated !Create/Update forms)
    2020* PDF (export only)
    2121* XLS (export only)
    2222* CSV
    2323
    24 Note: Method handlers for XML and JSON formats are integrated in the backend (S3Resource).
     24Note: Method handlers for XML and JSON formats are integrated in the backend ([wiki:S3XRC/RESTfulAPI/S3Resource S3Resource]).
    2525
    2626A good tool for testing the REST functionality is the [http://code.google.com/p/rest-client/ RESTClient]