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@redhat.com https://www.redhat.com/mailman/listinfo/rest-practices