From Microformats Wiki
Revision as of 22:25, 27 September 2007 by DrErnie (talk | contribs) (method)
Jump to navigation Jump to search

URL Conventions

The recommended conventions for RESTful URLs are those used by Ruby on Rails. Note that it is essential to use the proper HTTP verb for the desired action. Note that the principal unit of operation is the "collection", which typically corresponds to a database table or (in Rails) an ActiveRecord class. Following these conventions will allow your application to be consumed by ActiveResource, Jester, and other RESTful clients.

For a collection name "people", the primary routes would be:

GET /people/
return a list of all records
GET /people/new
return a form for creating a new record
POST /people
submit a form for creating a new record
GET /people/1
return the first record
DELETE /people/1
destroy the first record
GET /people/1/edit
return a form to edit the first record
PUT /people/1
submit a form for editing the first record