API Pattern Standard Decisions (표준화 관련 결정 사항)

[jinyoung]

• 복수형 or 단수형

  http://localhost:8080/instances or http://localhost:8080/instance

• Hateoas 에서는 보통

  http://localhost:8080/instance 로 접근하면
  _embedded 에 instances 필드로서 자신의 리스트를 뿌리는 것이 표준임.

• 따라서, 다음과 같이 표준화 함:

  복수형:  http://localhost:8080/instance  의 _embedded.instances 값을 가지고 옴
  단수형:  http://localhost:8080/instance/{id} 로 id 값을 넘겨서 받아옴

현재 표준에 따라 변경되어야 하는 url 들:

 ProcessInstanceRepository --> path="instance" 로 변경 필요
 WorkListRepository --> collectionResourceRel="worklists" 로 변경 필요
 RoleMappingRepository --> collectionResourceRel = "rolemappings" 로 변경 필요

[jinyoung]

동반하여, 기존 UI (vueJS 코드) 들도 변경 필요함.

11월에 일괄 적용

[jinyoung]

https://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api/

모든 참여자들 꼭 위의 가이드라인 보시고 api 설계시 준수 바랍니다

[jinyoung]

Hateoas 방식으로 전환한 샘플:

• 클라이언트: https://github.com/TheOpenCloudEngine/uEngine5-base/commit/2e03666edaa4f5d9b008bc35b6559a7fcf70f80b

• 서버사이드: https://github.com/TheOpenCloudEngine/uEngine5-base/commit/effa1fde5b4a618ca7c81f7cafef2884b7351f99

[jinyoung]

Hateoas 의 API checkpoints:

1. 한번의 진입점 (aggregation root) 에 대한 url 정보만으로 모든 이후의 액션과 association 데이터들은 _links 를 통하여 accessible 해야 한다. 따라서, front 와 back-end 는 가능한 변경에 대하여 분리가 이루어져야 한다.

2. 클라이언트 (자바스크립트)는 명시적인 uri pattern 에 대한 템플릿을 구성하여 uri 를 생성해서는 안된다. 가능한 데이터가 자신의 self url 과 자신의 행위에 대한 url 을 쥐고 다니도록 구현한다. 즉, hybind 나 traverson 같은 라이브러리를 사용한다.