wiki:BluePrintREST

Version 20 (modified by Fran Boon, 13 years ago) ( diff )

--

RESTful API

This page hosts detailed specifications for Blueprint for the RESTful API.

Basic approach for the S3 architecture is to have a Web Services backend & a Javascript client front end. RESTful APIs make this easier.

Web2Py generates URLs in this format:

/application/controller/function/arg1/arg2?var1=x,var2=y

These are generally fairly RESTful anyway, e.g.:

/sahana/gis/add_feature
/sahana/gis/list_features
/sahana/gis/features          # List_add
/sahana/gis/display_feature/1
/sahana/gis/update_feature/1

We can easily change to URLs like these (see BluePrintRESTImplementation):

/sahana/gis/feature           # Acts as 'list'
/sahana/gis/feature/id        # Acts as 'display'
/sahana/gis/feature/create
/sahana/gis/feature/list
/sahana/gis/feature/list_add
/sahana/gis/feature/display/id
/sahana/gis/feature/update/id
/sahana/gis/feature/delete/id

However, is there much benefit in this?
There are downsides:

  • We need to be authenticated for all actions (unless we patch T2)
  • Controller functions are less readable, with more levels of indent.

NB T3 requires ID to be the last argument, so don't want URLs like: /id/create

We want to be able extending this for exporting raw data in other formats, e.g. using the optional vars:

/sahana/gis/feature/display/x?format=[json|xml|csv]

Web2Py already supports export as JSON, CSV & RTF.

It would be best for us to add support to the framework to make it easy for module writers to have this functionality within their controllers.

NB Web2Py currently doesn't support HTTP PUT/DELETE/UPDATE (only GET).
This means a little work in clients but isn't too bad if we maintain consistency: no variations between add/create, view/display, edit/update, etc

Discussion of changes to Web2Py to make it more RESTful:

Web Services

Allows multiple client UIs

REST instead of SOAP

Less bloat, more GIS-friendly.

Python REST Servers

Python REST Clients

Javascript REST clients

Other REST clients

Note: See TracWiki for help on using the wiki.