예전에 Restful API는 자원의 단위로 소통하는 것을 의미한다고 했다 . 추가적으로 표준이되는 API명세서가 Restful API이다.
표준
1. 메소드 : 동사/ uri : 명사
예를 들어, 회원가입을 할 때, post이고, 행위의 주체는 user가 된다. 따라서, 메소드는 post가 되고, uri는 user가 된다. 즉,post createUser가 아니라 post user가 되는 것이다.
유저들을 전체 조회할 때는, get이 메소드가 될것이고 users가 uri가 될 것이다. 하지만, 특정 user만을 조회하는 경우도 있을 것이다.
이때는 path variable이 필요하다. 이것은 특정 데이터를 가리킬때 사용된다. 9번 을 조회한다고할 때 : user/100 이런식으로 조회하게 될것이다.
그리고 클라이언트 쪽에 전달을 해줄 때는, /user/:userIdx 즉, 이 자리가 userIdx의 자리라는 것을 명시를 해줘야한다.
즉,queryString도 있고, path variable도 있는데 용도가 다른 것이다.
queryString은 검색,필터링,페이징에서 사용이된다.
검색 : https://search.naver.com/search.naver?where=nexearch&sm=top_hty&fbm=1&ie=utf8&query=%EC%BD%94%EB%94%A9 이런식으로 마지막에 query=어쩌구저쩌구로 검색을 하는 것이고
필터링은 get user?age=12인 이런 식으로 조회를 할 수 있는 것이다.
2. 명사와 명사의 구분자는 하이픈으로!
ex) blocked-users
