REST API의 작업 결과에 대한 적절한 응답

Question

나는 POST 코드의 인터페이스를 가진 REST API을 관리합니다. 이 코드는 컴파일되고 사용자에게 결과를 보내야하지만 컴파일하는 데 오랜 시간이 걸릴 수 있으므로 사용자에게 다시 보내려는 것이 좋습니다 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" 
}