通过 REST API 指定对 运行 的操作
specify an action to run via REST API
只是想知道在休息时指定端点的最佳做法是什么 "runSomeAction"?我知道 GET、POST、PUT、DELETE 操作的用途以及使用名词来指定这些端点,但是公开非 CRUD 类型操作的服务器功能的首选方法是什么?
编辑:
操作的结果只会在服务器上启动一个进程,并且 return 状态立即为 200(在进程完成之前),没有正文。此过程具体是 运行 一些针对数据库中已保存项目的验证规则。
行动的最终结果是什么?通常,您执行 PUT/POST 来创建结果资源。例如,您可以 POST /email-notifications
.
而不是 POST /sendEmail
编辑
对于您的情况,我认为您的资源是验证的结果。我会建议 POST /validations
或 POST /validations/{whateverTypeIsBeingValidated}
。您也可以选择 validation-results
。即使您现在不支持客户端查看验证结果,您也可以选择稍后再查看。
此外,根据@MartinBroadhurst,REST API 可能不是理想的工具。
只是想知道在休息时指定端点的最佳做法是什么 "runSomeAction"?我知道 GET、POST、PUT、DELETE 操作的用途以及使用名词来指定这些端点,但是公开非 CRUD 类型操作的服务器功能的首选方法是什么?
编辑:
操作的结果只会在服务器上启动一个进程,并且 return 状态立即为 200(在进程完成之前),没有正文。此过程具体是 运行 一些针对数据库中已保存项目的验证规则。
行动的最终结果是什么?通常,您执行 PUT/POST 来创建结果资源。例如,您可以 POST /email-notifications
.
POST /sendEmail
编辑
对于您的情况,我认为您的资源是验证的结果。我会建议 POST /validations
或 POST /validations/{whateverTypeIsBeingValidated}
。您也可以选择 validation-results
。即使您现在不支持客户端查看验证结果,您也可以选择稍后再查看。
此外,根据@MartinBroadhurst,REST API 可能不是理想的工具。