[rest-practices] Piece on RESTful API Design

[Tobias Kunze]

Hi Geert-

Awesome piece, thanks a lot for writing it up! I think this is sorely needed and we'll try to pattern FataMorgana after it as much as we can.

I have a couple remarks/questions/suggestions/caveats, though, see attached annotated PDF. Let me know what you think—we can also take it offline.

-Tobias

-------------- next part --------------
A non-text attachment was scrubbed...
Name: restful-api-design.pdf
Type: application/pdf
Size: 365440 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/rest-practices/attachments/20110823/d2d23baa/attachment.pdf>
-------------- next part --------------



On Aug 9, 2011, at 05:06 , Mark Little wrote:

> I like it. We should try and link it into the REST-* web site too.
> 
> Bill, what do you think?
> 
> Mark.
> 
> 
> On 4 Aug 2011, at 00:10, Geert Jansen wrote:
> 
>> Hi,
>> 
>> i wanted to do this for a long time, and finally got it it. See the link below for an essay on RESTful API design, based on lessons learnt from rhevm-api project:
>> 
>> http://readthedocs.org/docs/restful-api-design/en/latest/
>> 
>> From the intro: "This is essay is an attempt to put down my thoughts on how to design a real-world yet beautiful RESTful API." It goes into such topics as JSON vs XML, why not XMLSchema, creating CLIs, and more.
>> 
>> Mark, it also contains a worked out version of your idea to use forms for describing inputs.
>> 
>> Feedback is welcome!
>> 
>> Regards,
>> Geert
>> 
>> _______________________________________________
>> rest-practices mailing list
>> rest-practices at redhat.com
>> https://www.redhat.com/mailman/listinfo/rest-practices
> 
> ---
> Mark Little
> mlittle at redhat.com
> 
> JBoss, by Red Hat
> Registered Address: Red Hat UK Ltd, Amberley Place, 107-111 Peascod Street, Windsor, Berkshire, SI4 1TE, United Kingdom.
> Registered in UK and Wales under Company Registration No. 3798903 Directors: Michael Cunningham (USA), Charlie Peters (USA), Matt Parsons (USA) and Brendan Lane (Ireland).
> 
> 
> 
> 
> 
> _______________________________________________
> rest-practices mailing list
> rest-practices at redhat.com
> https://www.redhat.com/mailman/listinfo/rest-practices