Когда использовать подресурсы в Rest API?

Question

Этот вопрос связан с simillar один отправлен на RESTful design: when to use sub-resources?, но он не упоминает этот случай.

У меня есть этот пример

/cars/{carid} 
{ 
"id": 1, 
"brand": "something" 
"engine": 
{ 
"horse_power": 100, 
"type": "hybrid" 
} 
} 

Что бы правильное рассуждение, что могло бы помочь мне решить, если этот пример должен быть разделен на суб-ресурс, чтобы выглядеть следующим образом

/cars/{carid} 
{ 
"id": 1, 
"brand": "something" 
} 

/cars/{carid}/engine 
"engine": 
{ 
"horse_power": 100, 
"type": "hybrid" 
} 

Answer 1

Maybe расщеплению основной ресурс в несколько подресурсов имеет смысл, если основной ресурс является сложным объектом со многими массивами и другими связанными объектами.

Однако, если вас беспокоят проблемы с производительностью, имейте в виду, что premature optimization is the root of all evil. Вы не должны оптимизироваться до тех пор, пока у вас не возникнет проблема с производительностью, и вы доказали, что проблема с производительностью связана с отправкой большого количества ресурсов.

---

Для ситуации, указанной в вопросе, поддерживая суб-ресурс как /cars/{id}/engine может быть полезным при замене всего двигателя автомобиля, следующим образом:

PUT /cars/1/engine HTTP/1.1 
Host: example.org 
Content-Type: application/json 

{ 
    "horse_power" : 110, 
    "type" : "eletric" 
} 

HTTP/1.1 204 No Content 

При запросе /cars/1 , будет возвращено полное представление о машине, включая двигатель,:

GET /cars/1 HTTP/1.1 
Host: example.org 
Accept: application/json 

HTTP/1.1 200 OK 
Content-Type: application/json 

{ 
    "id" : 1, 
    "brand" : "something", 
    "engine" : { 
    "horse_power" : 110, 
    "type" : "eletric" 
    } 
} 

Чтобы вернуть частичное представление ресурса, рассмотрите подходы, упомянутые в этом документе answer.

При запросе /cars/1/engine, представление двигателя будет возвращено:

GET /cars/1/engine HTTP/1.1 
Host: example.org 
Accept: application/json 

HTTP/1.1 200 OK 
Content-Type: application/json 

{ 
    "horse_power" : 110, 
    "type" : "eletric" 
}