如何使用 to 参数定义 REST API

Posted 2023-02-19

【中文标题】如何使用 to 参数定义 REST API

【英文标题】：How to define REST API with to Parameter

【发布时间】：2022-01-19 10:29:49

【问题描述】：

我目前正在为一个项目开发 REST API。在此过程中，我应该搜索事件。我想创建一个端点来搜索一段时间内的事件。即用from-to指定两个参数。

对于搜索，您通常执行 GET 操作。我现在的问题是在路径中指定两个参数是有意义的，还是我应该回退到类似的 POST 操作。

路径示例 /EventsFromTo

这对多个参数是否可行？

【参考方案1】：

如果您没有对资源进行更改，则应使用 GET 操作。 More detailed explanation:

如果您正在编写一个普通的旧 RPC API 调用，只要处理服务器端在两个调用之间没有区别，它们就可以在技术上互换。但是，为了使调用成为 RESTful，通过 GET 方法调用端点应该具有与 POST 方法（即创建新资源）不同的功能（即获取资源）。

带有多个参数的GET请求：/events?param1=value1&param2=value2

以数组为参数的GET请求：/events?param=value1,value2,value3

【讨论】：

感谢您的反馈。我认为它会像这样工作。我知道 API 的设计应该像 CRUD（更改 = POST，读取 = GET，更新 = PUT，删除 = DELETE）。所以当我使用 GET Methode 时，这将是最好的解决方案。