0

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

什么是 URL 结构的最佳实践?

这仅适用于 JSON。

假设这是一个博客应用程序:

例如:

获取所有帖子:

 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

是否有文件可以在某个地方进行处理?相当“官方”的东西?

4

3 回答 3

0

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

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

你会发现这是一个见仁见智的问题,没有官方规范,但你的 URL 对我来说看起来不错,并且符合那本书中的指导方针。可能的例外是最后一个。如果 1 是评论的唯一 ID,则 /posts/1/ 可能不是必需的。

于 2013-01-16T22:03:07.927 回答
0

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

Bob Aman 对这个 SO 问题的备受推崇的第二个答案提供了详细的指导: 如何创建没有动词的 REST URL?

于 2013-01-16T22:08:33.037 回答
0

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

于 2013-01-16T22:37:00.557 回答