REST API - включите сведения о связанных объектах или просто идентификаторы

Что лучше всего подходит для дизайна?

Если у меня есть объект A, который содержит некоторые связанные объекты, например, у меня есть объект автомобиля, и он различные типы.

Должен ли я по запросу api.example.org/cars/1 отвечать только идентификаторами этих ресурсов (так что, если кому-то нужны подробности о них, потребуется другой вызов API на api.example. org / type / 1 )

{
    "id": 1,
    "name": "Some Car",
    "types": [
        1,
        2
    ]
}

или также предоставьте подробную информацию об этих ресурсах

{
    "id": 1,
    "name": "Some Car",
    "types": [
        {
            "id": 1,
            "name": "Some Type",
            "something": "Blah"
        },
        {
            "id": 2,
            "name": "Some Type",
            "something": "Blah"
        }
    ]
}

Или укажите необязательный параметр, например «displayAll», а затем массив с именами параметров, которые должны быть получены за один вызов API (в этом case типы ).

13
задан svenkapudija 18 February 2012 в 01:32
поделиться