RESTful API에서 배열을 응답으로 반환하는 가장 좋은 방법은 무엇입니까?

이와 같은 리소스가 있다고 가정 해 봅시다.

book:
    type: object
    properties:
        author: {type: string}
        isbn: {type: string}
        title: {type: string}

books:
    type: array
    items: book

누군가가 GET책 리소스를 만들면 다음을 반환합니다.

[{"author": "Dan Brown", "isbn": "123456", "title": "Digital Fortress"},
 {"author": "JK Rowling", "isbn": "234567", "title": "Harry Potter and the Chamber of Secrets"}]

직장에서 누군가에게 권장되는 REST 사례는 항상 응답을 JSON 객체로 반환하는 것이라고 들었습니다 books.

books:
    type: object
    properties:
        list:
            type: array
            items: book

이제 응답은 다음과 같습니다.

{
    "list": [{"author": "Dan Brown", "isbn": "123456", "title": "Digital Fortress"},
             {"author": "JK Rowling", "isbn": "234567", "title": "Harry Potter and the Chamber of Secrets"}]
}

다음 중 가장 좋은 REST 방법은 무엇입니까?

실제로 두 번째 옵션은 모범 사례입니다. 그 이유는 배열을 반환 할 때 리소스를 전혀 확장 할 수 없기 때문입니다.

예를 들어 : 모든 레코드 수를 추가해야하는 경우 이미 배열 전용 방법으로 수행 된 것입니다.

그것이 하나의 목록 api에서 발생하면 일관성을 유지하기 위해 모든 객체를 만들면 API 가보다 일관되고 개발자가 더 쉽게 사용할 수 있습니다.

예를 들어, 개발자가 API를 사용하여 목록 및 세부 정보 페이지를 표시하는 일반 코드를 작성한다고 가정 해 보겠습니다. 그는 때로는 배열이고 때로는 목록 속성을 가진 객체이기 때문에 예외를 만들고 싶지 않습니다.

이 답변은 전체적으로 휴식, 증오 및 기타 프로토콜에 관한 원칙과는 아무런 관련이 없지만 고객에게 보내야하는 데이터에 대해서는 실제로 존재합니다. 예를 들어 hateos를 따르기로 결정했다면 오프 코스 표준 (또한 객체 btw)을 고수하십시오.

양자 모두

[{"author": "Dan Brown", "isbn": "123456", "title": "Digital Fortress"},{"author": "JK Rowling", "isbn": "234567", "title": "Harry Potter and the Chamber of Secrets"}]

과

{
    "list": [{"author": "Dan Brown", "isbn": "123456", "title": "Digital Fortress"},
         {"author": "JK Rowling", "isbn": "234567", "title": "Harry Potter and the Chamber of Secrets"}]
}

유효한 Json입니다. 필요하지 않은 경우 "목록"을 추가해야한다고 생각하지 않습니다. 다음에 오는 것이 목록이 아니라 배열이기 때문에 혼란 스러울 수도 있습니다.

최고의 REST 연습? API는 Accept 헤더에 설정된 내용에 대한 적절한 응답과 좋은 문서를 제공해야합니다.

응답 JSON을 준수하게 만드는 이유는 JSON이 사실상 표준 이기 때문입니다 . JSON 구문 분석기가있는 모든 언어는 사소하게 구문 분석 할 수 있으며 JavaScript를 사용하는 경우 JavaScript가 기본적으로 이해하므로 구문 분석기가 필요하지 않습니다.

즉, JSON과 호환되도록하고 고유 한 구문 분석기를 작성할 필요가 없습니다. 또한 다음 개발자가 서비스를 사용하는 소프트웨어를 작성할 때 놀라운 일은 없을 것입니다.

REST는 JSON 스키마와 관련이 없습니다. REST 관점에서 스키마 중 하나를 사용할 수 있습니다.

의미없는 단일 키 "목록"과 배열 값을 가진 사전은 의미가 없습니다. 대신 배열을 반환하십시오.

동일한 서비스가 서적, CD 또는 DVD를 리턴 할 수있는 경우 키 "books"및 배열 값을 가진 사전을 리턴 할 수 있습니다. DVD 배열을 가진 또 다른 키 "DVD"가있을 수 있습니다. 예를 들어 고객이 모든 구매 목록을 조회 할 수있는 경우입니다.

응답이 책 목록으로 만 해석 될 것이 확실하다면 (요청에 "도서 목록 제공"이라고 말한 경우) 배열 만 있으면됩니다.

두 번째 옵션은 보안상의 이유로 선호되는 방법이기도합니다. 오래된 브라우저에는 웹 페이지의 다른 자바 스크립트 코드가 JSON 배열로 반환되는 경우 데이터를 훔칠 수있는 보안 취약점이 있습니다. 역사적으로 가장 좋은 방법은 JSON 배열을 반환하지 않는 것입니다. 실제로 배열을 전달할 때 "json-ify"함수가 기본적으로 옵션 2를 선택하는 일부 프레임 워크가있었습니다.

https://stackoverflow.com/questions/3503102/what-are-top-level-json-arrays-and-why-are-they-a-security-risk

http://ejohn.org/blog/re-securing-json/

둘 다 json이며 REST를 준수합니다. 귀하의 사례 변경 목록에서 책에 대한 답변을보다 자세하게 설명하겠습니다. 또는 이와 같은 것 :

{ "responceObject" : {

   results : 2,

    "Books": [
        {"author": "Dan Brown", "isbn": "123456", "title": "Digital Fortress"},
        {"author": "JK Rowling", "isbn": "234567", "title": "Harry Potter and the Chamber of Secrets"}
    ]

}}