REST API下特定资源的正确术语是什么?

时间:2015-02-02 11:55:59

标签: rest api-design

说我在:

提供REST API
https://mycompany.com/api/v1

GETting https://mycompany.com/api/v1/user/<userID>将返回有关该用户ID的用户的信息(如果存在)。

/user/<userID>的正确术语是什么?

我已经考虑过“端点”这个词了。但是它可以用来表示https://mycompany.com/api/v1处的常规REST API端点和https://mycompany.com/api/v1/user/<userID>处的特定资源端点。我希望尽可能具体。

修改:将/ users / users更新为/ user作为备注下方的海报。

2 个答案:

答案 0 :(得分:2)

我发现了这个问题,因为我也想知道这个问题。 然后我发现了ThoughtWorks的这篇文章:REST API Design - Resource Modeling

它使用术语“集合资源”与“单例资源”,我觉得这很有帮助。

示例:

# collection resource:
/customers

# singleton resource
/customers/id-123

与上述评论者相比,我会积极鼓励您在各地使用复数资源名称,以保持语义一致,但我想我们可以同意在那里不同意。

答案 1 :(得分:0)

您的情况下,端点为/users

/users/id  

resource,命名可以根据您的请求方法更改。 (post / get / fetch / put等)。总之,它是端点的资源。 this资源可能对您有用