REST API中对作业的适当响应

Question

我管理的REST API具有来自用户的POST代码的接口。此代码被编译并应将结果发送给用户，但由于编译可能需要很长时间，因此我更愿意向用户发送 202 Accepted HTTP代码。

在用户再次尝试GET资源的事件中，成功的代码是什么，这意味着编译成功，错误，这意味着它不是？

Answer 1

在编译完成后对该资源执行GET时，我会返回200 OK以及指示编译成功或失败的响应正文。在这里，我将使用JSON作为媒体类型。例如，当编译成功时，您将得到此响应：

HTTP/1.1 200 OK

{
    "status" : "success"
}

如果编译失败，你可能会包括它失败的原因，可能是从编译器输出或类似的：

HTTP/1.1 200 OK

{
    "status" : "failure",
    "reason" : "syntax error"
}