REST에서 복잡한 연산을 어떻게 모델링합니까?

Question

캐릭터가 다른 대상과 캐릭터에 대해 복잡한 동작을 수행 할 수있는 온라인 게임을 개발 중입니다. 나는 REST API를 구축하고 있으며 가장 기본적인 표준조차도 따르려고 많은 어려움을 겪고있다. REST가 항상 답이되는 것은 아니라는 점을 알고 있지만, API의 나머지 부분에서 REST를 적절하게 사용하므로 REST를 사용하는 것이 여러 가지 이유에서 유용합니다.

GET/문자/밥/항목 이 밥이 수행되는 항목의 배열을 반환

는 여기에 몇 가지 까다로운 예입니다.

이 항목들에 대해 다양한 '작업'을 수행해야하며이를 '자원'으로 모델링하는 데 매우 어려움을 겪고 있습니다. 여기

는 항목의 특성에 따라 몇 가지 잠재적 인 작업입니다 던져, 드롭, 먹는

이 '작업'특정 항목에만 적합하기 때문이 복잡 누르고 있습니다. 예를 들어 칼을 먹을 수는 없습니다. 더욱이, '먹는 것'은 본질적으로 자원을 '삭제'하는 부작용이 있습니다. 'throw'를 사용하면 리소스를 '삭제'할 수도 있습니다. 'drop'을 사용하면 리소스를 다른 리소스 유형으로 '변환'할 수 있습니다. '던지다'는 '위치'를 제공해야합니다. '보류'를 선택하면 항목을 보유 할 손을 제공해야합니다. 그러면 이러한 작업을 자원으로 어떻게 모델링합니까? 그들 각각은 서로 다른 매개 변수를 필요로하고 전혀 다른 행동을하기 때문에 '모두 비슷합니다'는 없습니다.

현재 이러한 임의의 작업을 POST하는 'actions'리소스가 있습니다. {: 5, 해당 itemId : 10, X : 100, Y : 150 characterId}

Answer 1

I

POST/액션/ 을 던져 :하지만이 방법으로 검색 가능/너무 RPC와 비 표준화 된 느낌 가능하면 리소스에 충실하고 GET/POST/PUT/PATCH/DELETE를 시도하지만 기본 동사는 CRUD 호출에 직접 매핑되는 경향이 있습니다. 다른보다 복잡한 작업은 일반적으로 추가 정보없이 매핑 될 수 없습니다. 작업이 항목에 적합하지 않은 경우

POST /characters/bob/items/{bombId}?action=throw 
POST /characters/bob/items/{foodId}?action=eat 
POST /characters/bob/items/{potionId}?action=add&addedItem={ingredientId} 

반환 오류 :

는 자원에 초점을, 나는 아마 이런 식으로 뭔가 (자원에 메시지를 게시을) 할 것입니다.

Answer 2

내가 RESTful 인 상태에서 "복잡한 작업 수행"을 원한다면, 내가 원하는 것을 설명하는 리소스에 대한 복잡한 문서를 게시 할 것입니다. (복잡한 문서는 XML, JSON 또는 기타 여러 가지 형식이 될 수 있습니다.) POST를 "자식 리소스 만들기"에 매핑하는 일반적인 패턴과는 다소 다르지만 POST의 의미는 "do non- 멱등 류 본문 내용에 의해 정의 된 행동 "입니다. 그것은 당신이 겪고있는 것에 대한 합당한 적합성입니다.

HATEOAS의 검색 원리의 일부로 나중에 POST 할 리소스를 얻을 때 반환되는 문서의 일부는 이러한 복잡한 작업 문서가 무엇인지, 어디로 보내야하는지 알려줍니다. 논리적으로 양식을 작성하고 제출하십시오 ("양식"이 실제로 JSON 문서 또는 이와 유사한 내용에 슬롯이 있더라도).