资源名称/创建 [POST] 与资源名称 [POST] 之间的 API 端点 URL 差异

Question

我想知道它是否更好用

sku/article/create [POST]

或

/sku/article [POST]

在第一个 URL 中我指定了操作；这被认为是一种好习惯吗？我已经看到两者都被一致使用。人们是否专门指定操作以提高代码可读性？它的目的是什么？

Answer 1

如果您尝试设计level 3 API，则 HTTP 动词指示操作； IE。 POST 是一个动作，通常暗示创建。因此，第一种选择是多余的。

您通常会看到受支持动词的常见组合。例如，支持POST 和GET 的资源是“集合”资源，因为您可以使用POST 添加到它，并且您可以使用GET 查看整个集合，包括您刚刚创建的那个POST。