宁静网址的最佳做法是什么?

时间:2013-01-16 21:20:12

标签: ruby-on-rails rest jersey

我有一个基于java的休息服务器,我的客户端将主要使用Ruby。

什么是URL结构的最佳做法?

这仅适用于JSON。

说这是一个博客应用程序:

e.g:

获取所有帖子:

 GET http://www.example.com/api/v1/posts.json

删除ID为1的帖子:

DELETE http://www.example.com/api/v1/posts/1.json

嵌入式集合如何:

获取帖子1的所有评论:

GET http://www.example.com/api/v1/posts/1/comments.json

以ID 1查看帖子1的评论:

GET http://www.example.com/api/v1/posts/1/comments/1.json

是否有文件在某处?什么东西相当“官方”?

3 个答案:

答案 0 :(得分:0)

Apigee有一本关于RESTful API设计的免费电子书。您必须提供一个电子邮件地址才能获得它:

http://offers.apigee.com/api-design-ebook-rr/

你会发现这是一个意见问题,没有官方规范,但你的网址对我来说很好,并且符合该书中的指导原则。可能的例外是最后一个。如果1是评论的唯一ID,则可能不需要/ posts / 1 /。

答案 1 :(得分:0)

您可以从创建REST的论文开始,然后查看URI部分: http://www.ics.uci.edu/~fielding/pubs/dissertation/evaluation.htm#sec_6_2

鲍勃·阿曼(Bob Aman)对这个问题的第二个答案备受好评,提供了详细的指导: How to create REST URLs without verbs?

答案 2 :(得分:0)

正确使用HTTP协议是最好的主意。阅读一些关于url版本的内容。 http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http