REST API Design Guidelines

[Manoj Agarwal]

I am in the process of writing the REST API Design Guidelines for my group. Please share if you have any such guidelines, or know any resource/book. I will compile and share with the group. Thanks!

[Jerome Louvel]

In our recently published 'Restlet in Action' book, we have an Appendix D on "Designing a RESTful web API" that you might want to check out.

Sorry for the plug, but I thought this would be of direct interest in your current effort.

Jerome

[Suelen Goularte Carvalho]

Hi Manoj,

I am reading the book Web API Design created by apigee company and I have liked it. 

I hope that it help you.

Regards,

--

Suelen Goularte Carvalho
suelengc.com.br | @suelengc

+55 11 99336-7069

On Mon, Sep 16, 2013 at 12:35 PM, Manoj Agarwal <Manoj....@live.com> wrote:

I am in the process of writing the REST API Design Guidelines for my group. Please share if you have any such guidelines, or know any resource/book. I will compile and share with the group. Thanks!

--
You received this message because you are subscribed to the Google Groups "API Craft" group.
To unsubscribe from this group and stop receiving emails from it, send an email to api-craft+...@googlegroups.com.
Visit this group at http://groups.google.com/group/api-craft.
For more options, visit https://groups.google.com/groups/opt_out.

[Jørn Wildt]

I usually recommend the following resources:

• "Rest in practice" : http://www.amazon.co.uk/REST-Practice-Hypermedia-Architecture-ebook/dp/B0046RERXY
• "Restful webservices cookbook" : http://www.amazon.co.uk/RESTful-Web-Services-Cookbook-ebook/dp/B0043D2ESQ
• "Hypermedia APIs with HTML5 and Node.js" : http://www.amazon.co.uk/Building-Hypermedia-APIs-HTML5-Node/dp/1449306578
• "How to GET a cup of coffee" : http://www.infoq.com/articles/webber-rest-workflow
• And I am pretty sure that Mike's new book "RESTful web APIs" is going to be good: http://www.amazon.co.uk/RESTful-Web-APIs-ebook/dp/B00F5BS966
  

Unfortunately REST is not something you just explain in a bulleted list - it does require quite a bit of understanding of the architectural principles it defines. And, furthermore, there are different ways of interpreting REST which doesn't really help understanding.

In my personal case, and I have been trying to do the same as you, I ended up on a long and immensely interesting journey into REST. Then I wrote the first parts of the API our company presents and used that as a guideline for future extensions. Guidelines by examples only.

/Jørn

On Mon, Sep 16, 2013 at 5:35 PM, Manoj Agarwal <Manoj....@live.com> wrote:

I am in the process of writing the REST API Design Guidelines for my group. Please share if you have any such guidelines, or know any resource/book. I will compile and share with the group. Thanks!

--

[Roger Rohrbach]

Mark Massé's REST API Design Rulebook is a great starting point for such a document.

[Suelen Goularte Carvalho]

Great references, thanks too!

--

Suelen Goularte Carvalho
suelengc.com.br | @suelengc

+55 11 99336-7069

On Tue, Sep 17, 2013 at 1:55 PM, Roger Rohrbach <ro...@ecstatic.com> wrote:

Mark Massé's REST API Design Rulebook is a great starting point for such a document.

--

[Emmanuel Paraskakis (@manp)]

Of course the old standby is RESTful Web Services http://www.amazon.com/Restful-Web-Services-Leonard-Richardson/dp/0596529260

Due to be superseded by the new edition (Mike's book mentioned above).