REST API:如何命名派生资源?

时间:2014-02-18 00:28:12

标签: api rest

有关RESTful接口命名约定的大量问题,尤其是。围绕单数与复数资源名称。有点习惯是:

GET /users Retrieve collection of users
GET /users/{id} Retrieve user
POST /users Create user
PUT /users/{id} Update user
DELETE /users/{id} Delete user

但是,当资源是从环境派生的值时,上述操作无效。

我的假设应用程序具有以下端点:

GET /source Get information about the source of the query.

回应:

  • 推荐人网址
  • 远程IP

由于source派生自环境,因此永远不会有多个源,因此调用资源sources或提供sources/{foo}查找是不切实际的。

REST样式是否建议如何处理这些实体的命名?

1 个答案:

答案 0 :(得分:0)

博士。 Fielding在其着名的dissertation

的第6.2.1节中的注释
  

..作者需要一个与其语义紧密匹配的标识符   打算通过超媒体引用,允许引用保留   即使访问该引用的结果可能会改变,静态也是如此   随着时间的推移。

因此,使用普通的source端点是有意义的。

如果您希望提供更多关于提供的IP地址的一般服务,例如this one,那将是另一回事。