命名用于编译/映射/处理数据的 REST 端点

Posted 2023-03-09

技术标签:

【中文标题】命名用于编译/映射/处理数据的 REST 端点【英文标题】：Naming a REST Endpoint for compiling/mapping/processing data 【发布时间】：2021-06-02 13:40:42 【问题描述】：

我正在构建一个宁静的 api。该应用程序从前端的用户那里获取数据（来自数据表单或上传的文件），将其发送到后端进行处理并返回处理后的数据。它不会保存数据或访问其他资源。命名 RESTful 端点的好方法是什么？端点不访问资源，更多的是 RPC。我想过有类似的东西

api/compiliations/excel
api/compilations/myinput

命名此端点的最佳方式是什么？

【问题讨论】：

【参考方案1】：

POST /api/compilations/excel
POST /api/compilations/myinput
POST /ea53d835-2298-4a50-bd41-2097b6a8bc33

这些都很好。 REST 不关心您为 URI 使用的拼写约定。因此，请选择任何符合您当地惯例的拼写方式，以方便某些人（例如，需要查看访问日志的操作员）。

【讨论】：

以上是关于命名用于编译/映射/处理数据的 REST 端点的主要内容，如果未能解决你的问题，请参考以下文章