rest - 如何设计用于电子邮件发送服务的REST API？

Question

如何通过使用POST，GET，PUT，DELETE设计用于电子邮件发送服务的REST API？

send: POST - /email
retrieve: GET - /email/{id}
delete: DELETE - /email/{id}

这是设计REST API的正确方法吗？我觉得将POST映射到 Action “发送”并不直观。

Answer 1

您提供的方案是正确的。或者，您可以使用 Controller 执行一些更复杂的操作。

您的情况如下所示:

(action)           (verb)   (URI)                             (type)
create:            POST   - /emails                         - collection
retrieve:          GET    - /email/{id}                     - resource
update:            PUT    - /email/{id}                     - resource
delete:            DELETE - /email/{id}                     - resource
send immediately:  POST   - /email/{id}/sendImmediately     - controller
just send:         POST   - /email/{id}/send                - controller
do something else: POST   - /email/{id}/someOtherActionType - controller

注意新的 Controller ，更改创建起作用。后者是相当主观的，但是很合理(因为您不能真正访问“没有实际电子邮件”的URL，就像我没有“ /email”部分那样解释“ {id}”)。

其他资源:

REST API Design Rulebook