以 RESTful 方式调用远程过程

Question

我想做一个提供端点的Web服务，用户可以通过这些端点生成和操作保存在数据库中的配置文件。 端点

https://api.example.com/generate-new

应执行为用户生成标准配置文件的过程。 RESTful Web 服务应返回完整的配置文件作为答案(状态传输)。 由于配置文件还包含 api 密钥等敏感信息，因此在这里这是不可能的。

我只想返回一条成功消息。一个HTTP-200就足够了。 但这种方法仍然很满意吗？

Answer 1

问问自己：这里的资源(REST中的"R")是什么？听起来资源类似于用户配置生成任务。网址应反映这一点：

https://api.example.com/user-configuration-generation-tasks

假设对此集合资源的 HTTP POST 请求创建了一个新任务，可能使用请求正文中传递的信息。服务器执行此任务并生成新的用户配置。

现在，您有三个返回选项：

• 201 CREATED：这需要在响应中包含用户配置的Location。由于您不想使配置可访问，因此无法选择。
• 200 OK： 这将表明操作的总体成功。但由于您不打算返回任何回复，因此我不建议这样做。取而代之的是
• 204 NO CONTENT：服务器已成功完成请求，并且响应有效负载正文中没有要发送的其他内容。

这一切都是完全休息的。