From gjansen at redhat.com Wed Aug 3 23:10:59 2011 From: gjansen at redhat.com (Geert Jansen) Date: Thu, 04 Aug 2011 01:10:59 +0200 Subject: [rest-practices] Piece on RESTful API Design Message-ID: <4E39D583.7010909@redhat.com> 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 From bmcwhirt at redhat.com Sun Aug 7 14:46:43 2011 From: bmcwhirt at redhat.com (Bob McWhirter) Date: Sun, 7 Aug 2011 10:46:43 -0400 Subject: [rest-practices] Piece on RESTful API Design In-Reply-To: <4E39D583.7010909@redhat.com> References: <4E39D583.7010909@redhat.com> Message-ID: Geert-- This is geat work, and will definitely serve everyone well to have as a common document, since there's a lot of people flailing around with REST. I really appreciated your opions/justifications, such as those regarding Link: headers. The emphasis on non-XML is also quite refreshing. Seeing YAML is super. :) Thanks for putting this together. -Bob On Aug 3, 2011, at 7:10 PM, 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 From mlittle at redhat.com Tue Aug 9 12:06:03 2011 From: mlittle at redhat.com (Mark Little) Date: Tue, 9 Aug 2011 13:06:03 +0100 Subject: [rest-practices] Piece on RESTful API Design In-Reply-To: <4E39D583.7010909@redhat.com> References: <4E39D583.7010909@redhat.com> Message-ID: <2DDC0B54-C943-46E8-B9EB-D95ABEB4C201@redhat.com> 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). From bburke at redhat.com Tue Aug 9 13:17:22 2011 From: bburke at redhat.com (Bill Burke) Date: Tue, 09 Aug 2011 09:17:22 -0400 Subject: [rest-practices] Piece on RESTful API Design In-Reply-To: <2DDC0B54-C943-46E8-B9EB-D95ABEB4C201@redhat.com> References: <4E39D583.7010909@redhat.com> <2DDC0B54-C943-46E8-B9EB-D95ABEB4C201@redhat.com> Message-ID: <4E413362.6030806@redhat.com> sounds good. On 8/9/11 8:06 AM, 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). > > > > -- Bill Burke JBoss, a division of Red Hat http://bill.burkecentral.com From tkunze at redhat.com Wed Aug 24 06:08:31 2011 From: tkunze at redhat.com (Tobias Kunze) Date: Tue, 23 Aug 2011 23:08:31 -0700 Subject: [rest-practices] Piece on RESTful API Design In-Reply-To: <2DDC0B54-C943-46E8-B9EB-D95ABEB4C201@redhat.com> References: <4E39D583.7010909@redhat.com> <2DDC0B54-C943-46E8-B9EB-D95ABEB4C201@redhat.com> Message-ID: <5EB08E94-923B-4D78-849B-F1A2ABDC34B4@redhat.com> 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: -------------- 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