비동기식 웹 API 구현

Question

Google은 잠재적으로 매우 많은 양의 사용자 제출 콘텐츠를 처리하는 웹 API를 개발하고 있습니다. 즉, 엔드 포인트에 대한 호출이 즉각적인 결과를 반환하지 않을 수도 있음을 의미합니다. 따라서 비동기/비 차단 API를 구현하고자합니다. 현재 우리의 계획은 사용자가를 통해 콘텐츠를 제출하는 것입니다 :

POST /v1/foo 

JSON 응답 본문은 사용자가 후속 폴링에서 매개 변수로 제출 고유 요청 ID (A UUID)를 포함 같은 엔드 포인트에 묻은 :

GET /v1/foo?request_id=<some-uuid> 

작업이 완료되면 결과가 JSON으로 반환되고, 그렇지 않으면 상태 업데이트가 반환됩니다 (다시 JSON).

(그들은 모두 위의 호출을 실패하지 않는 한 단순히 "200 OK"응답을 반환합니다.)

이 비동기 API를 구현하는 합리적인 방법이 있나요? 이 작업을 수행하는 '올바른'(그리고 RESTful 한) 방법은 무엇입니까? 설명 된 모델 here은 임시 상태 업데이트 리소스를 만든 다음 최종 결과 리소스를 만들 것을 권장하지만 이는 불필요하게 복잡합니다.

Answer 1

실제로 언급 한 블로그 게시물에 설명 된 방법은 동기화 된 작업을 처리하는 '올바른'RESTful 방식입니다. 대용량 파일 업로드 및 변환을 처리하는 API를 구현했으며이 방법으로 처리합니다. 내 의견으로는 이것은 복잡하고 분명히 클라이언트 나 다른 것에 대한 응답을 지연시키는 것이 아닙니다.

몇 가지 추가 참고 사항 : 작업이 실패하면 200 OK을 작업 자원 표현과 자원 생성에 실패한 정보와 함께 반환합니다.