RESTful한 API명세 설계하기 실전
- 로직구조를 생각하면서 짜야한다. 이미 로그인한 상태라면 굳이 URL에 @PathVariable로 파라미터를 받을 필요가 없다. JWT에서 claims로 받아오면 되기 때문이다.
- 식별키를 @PathVariable으로 받아오는 상황이라면, 앞에 존재하는 entity는 복수형으로 하는게 좋다.
RESTful한 API의 장점 살리기
-
RESTful한 API를 설계한다면 그 API의 목적을 명확하게 나타내어 직관적으로 이해할 수 있다는 장점
- REST란 문서,그림,데이터 등의 자원을 이름으로 구분해서 해당 자원에 대한 상태나 정보를 주고받는 것을 의미합니다.
- 서버입장에선, restful API는 URI와 method를 통해 어떤자원에 어떻게 행위해달라고 요청이 온건지 직관적으로 알 수 있고
- 클라이언트입장에선, 응답코드를 통해 요청에 대한 응답이 어떤 상태인지 바로 알 수 있습니다.
-
명확하고 직관적인 요청과 응답은 서버와 클라이언트의 구조를 확실히 구분시킴으로써 서로간의 의존성이 낮아짐
- 이런 효과는 서버가 클라이언트의 컨텍스트 정보를 신경쓰지 않고 저장하지 않아도 됨
- 그리하여 서버의 stateless함을 유지할 수 있다는 장점
-
서버간의 정보인 컨텍스트 정보는 저장하지않더라도, 서버와 클라이언트 각자 여태까지 뭘받았고 뭘보냈는지는 기억함
- 기억함으로써 '캐싱'하기때문에 속도가 빠름
.