决定REST API路径约定

时间:2016-06-06 09:20:40

标签: api rest restful-architecture conventions

我正在为我的组织的分类部分工作,我需要为此部分提取城市。分类城市是城市的子集。因此,为了获取城市,我创建了以下API路径。

api/classified/cities 

然后我意识到,因为分类城市是城市的子集,所以URL可以是

api/cities/classifiedcities

我应该根据REST主体使用上述路径之一?

2 个答案:

答案 0 :(得分:2)

如果您的目标是REST原则,那么REST实际上并不具备URI的原理(只要它识别出真正的"资源!)。 It does however say它应该链接而不是硬编码到客户端。这就是some people say URI无关紧要的原因。它们并不重要,因为客户应该发现" URI而不是事先知道它们。

那么为什么我们都不选择像#34; / 45ttfdfg / 34tkfjdldf23wedkdfjsd"?那真的是个人偏好。如果URI是"可读"那就太好了。由人类。有一些(写得很糟)的工具假设了一些结构。有一些" REST"库(服务器和客户端)也假设一堆东西,例如" subresources" (也不是来自REST)。

总结一下:如果你遵循REST(你当然不必!),那么客户应该发现URI。如果是这种情况,则归结为个人偏好以及对图书馆/客户的一些技术限制。所以选择一个你喜欢的,不要担心它!无论如何,它们可以在以后修改,因为服务器可以控制其URI。

答案 1 :(得分:1)

理论上,子集应该遵循父集(因此第一个解决方案看起来不太好)。

三分之一的方法是通过查询参数:

stats:::wilcox.test.formula
相关问题