API中的自定义搜索

Question

我有一个API，可以对六个字段进行自定义搜索，大致如下，虽然也可能包括敏感数据，因为我在其他地方对相同类型的搜索使用了相同的方法

• 用户名
• 电子邮件
• 名字
• 姓氏
• 部门

我通常使用RESTful方法，因此对于用户列表或单个用户，检索用户的过程如下所示

GET /user
GET /user/1

然而，对于搜索，我对如何允许这样做有点困惑。我的初衷是在请求正文中使用JSON，例如

{
    "username": "someuser",
    "department": "sales"
}

我不能使用请求正文，因为这似乎是合乎逻辑的（和我使用的POST等行动），虽然，因为它是不支持的Chrome据我所知（或至少，不是由PostMan插件，我们用于测试）

因此，执行此搜索的最佳方式是什么？

我看到的选项

使用标头

这似乎是头的“错误”使用，但也是最接近原始请求正文的

在网址中使用参数

邪恶的笑（Evil Grin的缩写）

GET /user?username=someuser&department=sales

但是控制器会变得很混乱(使用C# Web API)，因为我不能将项目留空。所以请求应该更像这样，除非我有一大堆被覆盖的方法来处理不同的排列。这似乎...麻烦的

GET /user?username=someuser&email=&firstname=&lastname=&department=

也许更重要的是，它让人有点看不见了：这是在医疗环境中进行的，尽管有时不可避免地会显示东西，但我宁愿将其保持在最低限度（数据本身在传输过程中自然是SSL加密的）

使用其他HTTP动词

我可以使用POST或其他动词，这会起作用，但有违直觉，而且违背了RESTfulhtml" target="_blank">方法（据我所知）和我自己在项目中的标准，因此可能会令人困惑。

还有其他人遇到过这种情况吗？什么是“官方”或最好的处理方式？

Answer 1

没有真正的“官方”方式。在这种情况下，我只是稍微改变一下REST的规则，只使用一个帖子，传入一个身体是POST方法的用途。

关于Chrome不支持：这在Chrome以及PostMan扩展中完全支持（您需要选择一个POST方法并为正文选择原始选项，然后选择JSON）

另一方面，querystring也是一个不错的选择。通过使用控制器中的默认参数，可以有空项：

public ActionResult Search(string userName = "", int departmentId = 0)
{
    ...
}