api - 使用额外数据扩展资源端点？

Question

使用与所请求资源相关的附加数据来选择性地扩展资源端点通常不是一个好主意吗？

例子

GET/post/:id/ - 检索单个帖子

示例响应

{
 id : 1
 title : 'Hello world',
 body : 'Testing'
}

GET/post/:id/?includeMeta=1 - 检索带有附加元数据的单个帖子

示例响应

{
 id : 1
 title : 'Hello world',
 body : 'Testing',
 meta : {
     url : 'http://google.com',
     customMetaKey : 'some value'
 }
}

Answer 1

这取决于这些额外的值(value)是否属于主要资源。在您的情况下，如果它们属于名为“Post”的资源，那么它是完全可以接受的。事实上，您可以使用 Google 最先使用的名为“部分响应”的方法。在这种情况下，您必须添加一个名为“fields”的特殊 QueryString 属性，如下例所示。

GET /post/:id/?fields=metadata,field2,field3,association(field1,field2)

在此 queryString 中，您可以添加您希望在响应中返回的所有字段，包括关联。查看下面的文章以了解有关部分响应的更多信息:

• http://googlecode.blogspot.com.br/2010/03/making-apis-faster-introducing-partial.html

另一方面，如果这些额外的值(value)不属于主要资源，那么我认为它没有任何意义。如果客户端想要这些值，则它必须向拥有它的资源询问。