将rest api端点从动词修改为名词答案

【问题标题】：Modify rest api endpoint from verb to noun将rest api端点从动词修改为名词
【发布时间】：2022-11-04 09:54:56
【问题描述】：

我有一些休息的终点......看起来像这样

PUT --> /container/{vendorID}/{pluginID}/{containerName}/start
PUT --> /container/{vendorID}/{pluginID}/{containerName}/restart
PUT --> /container/{vendorID}/{pluginID}/{containerName}/stop

我看到start、stop 是一种动作/动词。现在确定如何将它们转换为名词。

寻找一些建议。

【问题讨论】：

标签： api rest

【解决方案1】：

我看到开始，停止是一种动作/动词。现在确定如何将它们转换为名词。

认识到resources 是文档的概括。作为操作这些文档的副作用，我们正在触发有用的工作。见Webber 2011。

“名词”是文档的名称。

您可以通过多种方式设计文档（也称为“资源模型”）。您可能有一个容器的起始文档。对于每个要启动它的场合，您可能有一个不同的启动文档。您可能对每个容器都有一个计划，并且您可以编辑计划以指示您希望什么时候开始。您可能只有一个容器本身的文档，然后对其进行编辑。

需要记住的一点是 REST/HTTP 非常关心缓存，所以你应该注意cache invalidation 的规则；今天的通用 HTTP 组件不支持任意资源的失效，因此您可能需要在设计资源模型时考虑这些限制。

【讨论】：

【解决方案2】：

不需要这样做，REST 中没有 URI 设计约束。如果你仍然想要，因为你遵循这个非官方的名词资源命名约定，那么它是基本的英语，开始 -> 开始，重新开始 -> 重新启动，停止 -> 停止。

【讨论】：