如何设计RESTful搜索/过滤?

我目前正在用PHP设计和实现一个RESTful API。然而，我一直没有成功地实现我的初始设计。

GET /users # list of users
GET /user/1 # get user with id 1
POST /user # create new user
PUT /user/1 # modify user with id 1
DELETE /user/1 # delete user with id 1

到目前为止都很标准，对吧?

我的问题是第一个GET /users。我正在考虑在请求体中发送参数以过滤列表。这是因为我想要能够指定复杂的过滤器而不得到一个超长的url，如:

GET /users?parameter1=value1&parameter2=value2&parameter3=value3&parameter4=value4

相反，我想要这样的东西:

GET /users
# Request body:
{
    "parameter1": "value1",
    "parameter2": "value2",
    "parameter3": "value3",
    "parameter4": "value4"
}

这是更可读的，让你有很大的可能性来设置复杂的过滤器。

不管怎样，file_get_contents('php://input')不会为GET请求返回请求体。我还尝试了http_get_request_body()，但我使用的共享主机没有pecl_http。反正也不确定是否有用。

我发现了这个问题，并意识到GET可能不应该有请求体。这有点不确定，但他们建议不要这么做。

所以现在我不知道该怎么办。如何设计RESTful搜索/过滤功能?

我想我可以使用POST，但这似乎不太RESTful。

当前回答

如果你在GET请求中使用请求体，你就破坏了REST原则，因为你的GET请求将不能被缓存，因为缓存系统只使用URL。

更糟糕的是，您的URL不能被书签，因为URL不包含将用户重定向到此页面所需的所有信息。

使用URL或查询参数而不是请求体参数，例如:

/myapp?var1=xxxx&var2=xxxx
/myapp;var1=xxxx/resource;var2=xxxx

事实上，HTTP RFC 7231说:

GET请求消息中的有效负载没有定义的语义;在GET请求上发送有效负载主体可能会导致某些现有实现拒绝该请求。

更多信息请看这里。

2015-02-23 11:53:28

其他回答

当我使用laravel/php后端时，我倾向于这样做:

/resource?filters[status_id]=1&filters[city]=Sydney&page=2&include=relatedResource

PHP自动将[]参数转换为数组，因此在本例中，我将以$filter变量结束，该变量包含一个数组/过滤器对象，以及一个页面和我想要加载的任何相关资源。

如果您使用另一种语言，这可能仍然是一个很好的约定，您可以创建一个解析器来将[]转换为数组。

2017-06-20 08:53:02

我认为你应该使用请求参数，但前提是没有适当的HTTP头来完成你想做的事情。HTTP规范没有明确说明GET不能有主体。然而，该文件指出:

按照惯例，当GET方法为使用时，所有信息都需要识别在其中编码的资源 URI。这里没有惯例 HTTP/1.1用于安全交互(例如，检索)，客户端提供将数据发送到HTTP实体中的服务器而不是在查询部分一个URI。这意味着为了安全操作，uri可能很长。

2011-02-16 19:02:24

实现RESTful搜索的最佳方法是将搜索本身视为一种资源。然后您可以使用POST动词，因为您正在创建一个搜索。为了使用POST，您不必在数据库中创建一些东西。

例如:

Accept: application/json
Content-Type: application/json
POST http://example.com/people/searches
{
  "terms": {
    "ssn": "123456789"
  },
  "order": { ... },
  ...
}

您正在从用户的角度创建搜索。它的实现细节是不相关的。有些RESTful api甚至不需要持久性。这是一个实现细节。

2013-09-21 14:39:32

如果你在GET请求中使用请求体，你就破坏了REST原则，因为你的GET请求将不能被缓存，因为缓存系统只使用URL。

更糟糕的是，您的URL不能被书签，因为URL不包含将用户重定向到此页面所需的所有信息。

使用URL或查询参数而不是请求体参数，例如:

/myapp?var1=xxxx&var2=xxxx
/myapp;var1=xxxx/resource;var2=xxxx

事实上，HTTP RFC 7231说:

GET请求消息中的有效负载没有定义的语义;在GET请求上发送有效负载主体可能会导致某些现有实现拒绝该请求。

更多信息请看这里。

2015-02-23 11:53:28

供你参考:我知道这有点晚了，但对任何感兴趣的人来说。这取决于你想要多RESTful，你必须实现你自己的过滤策略，因为HTTP规范在这方面不是很清楚。我想建议对所有过滤器参数进行url编码。

GET api/users?filter=param1%3Dvalue1%26param2%3Dvalue2

我知道它很丑，但我认为这是最RESTful的方式来做它，应该很容易在服务器端解析:)

2017-04-21 11:02:46

如何设计RESTful搜索/过滤?

推荐文章

最新文章

标签