/hateoas-binder

applied hateoas resource parsing in client

Primary LanguageJavaScriptMIT LicenseMIT

HATEOAS Binder

이 프로젝트는 "HATEOAS가 적용 된 Resource"의 링크들을 바인딩 해주는 클라이언트용 라이브러리 입니다.
HATEOAS는 개념적으로만 제안 되었으며, 표준규격이 존재하지 않지만 이 라이브러리에서는 이하에서 설명하는 전제를 따릅니다.

HATEOAS 전제

  1. REST API 에서 반환하는 Resource는 _links 프로퍼티를 가진다.
  2. _links 객체는 자신의 링크(self)를 포함해야 한다.
  3. 링크의 표현은 관계(rel), 주소(href), 동작(method)를 포함해야 한다.
  4. 반환한 데이터 중 배열이 포함된 경우, templated 옵션을 통해 특정 배열을 지정 할 수 있다. 지정된 배열에는 rel, href의 format으로 _links가 binding 된다.
  5. format 지정 시 $ 는 응답 resource 그 자체를 명시한다. 배열의 인덱스는 format 표현에서 제외된다.
  6. template 옵션이 지정 되었을 시, 파싱 후 _links에서 제거되며 지정된 배열 내 객체의 _links 를 추가 후, binding 된다.

** URL에서 프로토콜과 도메인을 명시하고 있지만, 같은 도메인에 존재하는 API에 호출 시 해당 내용은 생략이 가능하다. **

Resource 예시

Case 1 Request: API 진입점 요청

URL: "https://api.example.com/"
Method: GET

Case 1 Response

{
  "_links": {
    "self": {
      "rel": "API 진입점",
      "href": "https://api.example.com/",
      "method": "GET"
    },
    "list:board": {
      "rel": "게시판 목록 조회",
      "href": "https://api.example.com/board",
      "method": "GET"
    }
  }
}

Case 2 Request: 게시판 목록 조회

URL: "https://api.example.com/board"
Method: GET

Case 2 Response

{
  "_links": {
    "self": {
      "rel": "게시판 목록 조회",
      "href": "https://api.example.com/board",
      "method": "GET"
    },
    "view:board": {
      "template": "$.boards",
      "rel": "{$.boards.name} 게시판 조회",
      "href": "https://api.example.com/board/{$.boards.id}",
      "method": "GET"
    }
  },
  "boards": [
    {
      "id": 0,
      "name": "현대과학"
    },
    {
      "id": 1,
      "name": "유머"
    },
    {
      "id": 2,
      "name": "질문"
    }
  ]
}

Case 2 Parsed

{
  "_links": {
    "self": {
      "rel": "게시판 목록 조회",
      "href": "https://api.example.com/board",
      "method": "GET"
    }
  },
  "boards": [
    {
      "id": 0,
      "name": "현대과학",
      "_links": {
        "view:board": {
          "rel": "현대과학 게시판 조회",
          "href": "https://api.example.com/board/0",
          "method": "GET"
        }
      }
    },
    {
      "id": 1,
      "name": "유머",
      "_links": {
        "view:board": {
          "rel": "유머 게시판 조회",
          "href": "https://api.example.com/board/1",
          "method": "GET"
        }
      }
    },
    {
      "id": 2,
      "name": "질문",
      "_links": {
        "view:board": {
          "rel": "질문 게시판 조회",
          "href": "https://api.example.com/board/2",
          "method": "GET"
        }
      }
    }
  ]
}