REST API命名约定

时间:2017-04-03 11:15:04

标签: rest api

在工作中进行讨论时,我注意到一些API运行如下语法:

/webapi/messaging/getMessage?messageID=n (HTTP GET)

在我看来,这是不好的做法,有些同事似乎不同意。在我看来,这应该是

的内容
/webapi/messaging/messages/n (HTTP GET)

我是初学者,这两个例子都足够吗?如果一个更好,为什么它更好?我的推理来自于我在学习时所学到的东西,这可能是不好的信息。

由于

1 个答案:

答案 0 :(得分:4)

这应该不重要。 REST声明URL必须通过链接发现,例如普通网页中的链接。

但是,使用一致的,不言自明的URL结构始终是更好的选择。所以你的是使用REST API命名约定的更好方法。

/webapi/messaging/message/n (HTTP GET)

Reference