【问题标题】:Should response of rest api contain ID of a resource?rest api 的响应是否应该包含资源的 ID?
【发布时间】:2017-07-05 07:57:05
【问题描述】:

什么是rest api的良好实践或标准,服务器响应是否应该包含资源的ID?

例如,此响应包含资源的 id

GET /users/5
{
"user_id": 5
"first_name" : "John",
"last_name" : "Doe",
"minutes_active": 10
}

这假设资源的 id 是在请求​​的 url 中声明的

GET /users/5
{
"first_name" : "John",
"last_name" : "Doe",
"minutes_active": 10
}

【问题讨论】:

  • 如果您的客户需要该 ID 来处理它(例如将其包含在命令中),那么请务必包含它,否则不要。如果你想要一个 RESTFUL api,那么你的客户端会从服务器接收链接,它不会自己构建它们。

标签: rest api api-design


【解决方案1】:

这假设资源的 id 是在请求​​的 url 中声明的一个

从客户端的角度来看,URI 是不透明的;如果您通过将信息放入期望解析的 URI 中向客户端传达信息,那么您已经失去了情节。

如果您的 API 需要将 id 提供给客户端,则 id 应包含在资源的表示中。

您所说的“URI 是不透明的;如果您通过将信息放入期望他们解析的 URI 来与客户端通信信息......”是什么意思?在我看来,客户端创建了 URI,所以表面上它已经知道 ID...?

通常,REST API 客户端跟随链接,而不是构建 URI。 HTTP 请求中没有任何内容可以告诉您客户端是如何选择该特定 URI 的——它可能是一个书签,或者其他表示形式的链接,或者是填写表格的结果。

【讨论】:

  • “URI 是不透明的;如果您通过将信息放入期望解析的 URI 中向客户端传达信息……”是什么意思?在我看来,客户端创建了 URI,所以表面上它已经知道 ID...?
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2013-03-19
  • 1970-01-01
  • 2019-10-20
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2012-05-06
相关资源
最近更新 更多