REST API-API가 중첩 JSON 객체를 반환해야합니까?

JSON API와 관련하여 응답을 평평하게하고 중첩 된 JSON 객체를 피하는 것이 좋습니다.

예를 들어 IMDb와 유사하지만 비디오 게임용 API가 있다고 가정하겠습니다. 게임 및 플랫폼을 매핑하는 몇 가지 엔티티 인 Game, Platform, ESRBRating 및 GamePlatformMap이 있습니다.

/ game / 1을 요청하여 ID가 ​​1 인 게임을 가져오고 플랫폼과 esrbRating이 중첩 된 게임 객체를 반환한다고 가정 해 보겠습니다.

{
  "id": 1,
  "title": "Game A",
  "publisher": "Publisher ABC",
  "developer": "Developer DEF",
  "releaseDate": "2015-01-01",
  "platforms": [
    {"id":1,"name":"Xbox"},
    {"id":2,"name":"Playstation"}
  ],
  "esrbRating": {
    "id": 1,
    "code": "E",
    "name": "Everyone"
  }
}

JPA / Hibernate와 같은 것을 사용하는 경우 FETCH.EAGER로 설정된 경우 자동으로이를 수행 할 수 있습니다.

다른 옵션은 단순히 API를 작성하고 더 많은 엔드 포인트를 추가하는 것입니다.

이 경우 / game / 1이 요청되면 게임 오브젝트 만 반환됩니다.

{
  "id": 1,
  "title": "Game A",
  "publisher": "Publisher ABC",
  "developer": "Developer DEF",
  "releaseDate": "2015-01-01",
}

플랫폼 및 / 또는 ESRBRating을 원하면 다음을 호출해야합니다.

/ game / 1 / 플랫폼 / game / 1 / esrb

이 방법은 클라이언트가 필요로하는 데이터와 필요할 때에 따라 서버에 여러 번 더 호출 할 수있는 것처럼 보입니다.

당신이 이것과 같은 것을 가질 수있는 마지막 생각이있었습니다.

{
  "id": 1,
  "title": "Game A",
  "publisher": "Publisher ABC",
  "developer": "Developer DEF",
  "releaseDate": "2015-01-01",
  "platforms": ["Xbox","Playstation"]
}

그러나 이것은 ID 나 다른 플랫폼 정보와 관련된 정보가 필요하지 않다고 가정합니다.

API에서 반환 된 JSON 객체를 구성하는 가장 좋은 방법은 무엇인지 일반적으로 묻습니다. 가능한 한 엔터티에 가까이 접근해야합니까, 아니면 도메인 개체 또는 데이터 전송 개체를 사용하는 것이 좋습니다? 데이터 액세스 계층에 대한 더 많은 작업이나 클라이언트에 대한 더 많은 작업 중 하나의 방법으로 트레이드 오프가 발생한다는 것을 알고 있습니다.

또한 JPA / Hibernate 또는 MyBatis를 사용하여 API의 백엔드 기술로 Spring MVC를 사용하는 것과 관련된 답변을 듣고 싶습니다.

다른 대안 (HATEOAS 사용). 이것은 간단합니다. 대부분의 경우 실제로 HATEOAS 사용에 따라 json에 링크 태그를 추가합니다.

http://api.example.com/games/1:

{
  "id": 1,
  "title": "Game A",
  "publisher": "Publisher ABC",
  "developer": "Developer DEF",
  "releaseDate": "2015-01-01",
  "platforms": [
    {"_self": "http://api.example.com/games/1/platforms/53", "name": "Playstation"},
    {"_self": "http://api.example.com/games/1/platforms/34", "name": "Xbox"},
  ]
}

http://api.example.com/games/1/platforms/34:

{
  "id": 34,
  "title": "Xbox",
  "publisher": "Microsoft",
  "releaseDate": "2015-01-01",
  "testReport": "http://api.example.com/games/1/platforms/34/reports/84848.pdf",
  "forms": [
    {"type": "edit", "fields: [] },
  ]
}

물론 모든 목록에 모든 데이터를 포함시킬 수는 있지만 너무 많은 데이터가 될 수 있습니다. 이 방법을 사용하면 필요한 데이터를 포함시킨 다음 실제로 작업하려는 경우 더 많은 데이터를로드 할 수 있습니다.

기술 구현에는 캐싱이 포함될 수 있습니다. 게임 오브젝트에 플랫폼 링크 및 이름을 캐시하고 플랫폼 API를 전혀로드하지 않고도 즉시 전송할 수 있습니다. 그런 다음 필요할 때로드 할 수 있습니다.

예를 들어 양식 정보를 추가 한 것을 알 수 있습니다. 게임 목록에로드하려는 것보다 자세한 json 객체에 훨씬 더 많은 정보가 있음을 보여주기 위해 그렇게했습니다.

이것은 REST API 디자인과 관련하여 기본적인 질문 중 하나입니다. 모든 디자이너는 첫날에이 질문을합니다. 죄송하지만 답변은 "의존"입니다. 각 접근 방식에는 장단점이 있으며 결정을 내리고 진행하면됩니다.

https://www.slideshare.net/stormpath/rest-jsonapis에 제시된 접근 방식은 두 번째입니다.

즉, 중첩 된 자원을 상위 자원의 링크로 포함하는 한편 상위 엔드 포인트에서 확장 매개 변수를 제공하십시오.

제 생각에는 이것이 대부분의 경우 효율적이고 유연한 방법입니다.