PI @REST - inclua detalhes de objetos relacionados ou apenas IDs

Qual é a melhor prática de design?

Se eu tiver o objeto A e ele contiver alguns objetos relacionados, por exemplo, eu tenho um objeto de carro e vários tipo

Devo, a pedidoapi.example.org/cars/1 responda apenas com IDs a esses recursos (se alguém precisar de detalhes sobre eles, será necessária outra chamada de API emapi.example.org/type/1)

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

ou forneça detalhes sobre esses recursos também

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

Or forneça um parâmetro opcional como "displayAll" e, em seguida, faça a matriz com nomes de parâmetros que devem ser recuperados em uma única chamada de API (neste caso, types).

questionAnswers(4)

yourAnswerToTheQuestion