API 통신에서의 QueryParameter

Question

안녕하세요. 선배님들 이제 대학교 졸업을 앞두고 있는 학생입니다. 현재 토이 프로젝트로 팀원들과 함께 spring, jpa, react 프로젝트를 진행중에 있습니다. RestApi를 지키면서 프로젝트를 진행하면서 한 가지 의문이 생겼습니다. 저희가 진행하던 기존 프로젝트에서 filter, sort, page, size, search 와 관련된 내용들에 대해 프론트 쪽에서 Body로 보내고 백엔드에서 해당 Body를 객체로 전달받는 방식으로 진행하고 있습니다.예를 들어서, 게시판 호출 api 라고 하면@GetMapping("/boards/{category}/{sort}) public Page callBoard(@PathVariable String category, @PathVariable int sort, @RequestBody BoardRequestDto dto){ PageRequest pageRequest = PageRequest.of(boardCallDto.getPage(), boardCallDto.getSize()); return boardRepository.callByPaging(pageRequest); } class BoardDto { private Integer page; private Integer size; getter... setter... }위 방식을 채택하고 있습니다. 위와 같이 작성했을 때의 URI는 다음과 같습니다. /boards/tip/1 그런데 문득 paging과 관련된 parameter를 가지고 올때 Pageable 을 사용하는 예제를 많이 보았고, 그리고 대부분의 대기업의 포털 사이트를 보면 아직 filter, sort, page, size, search와 같은 검색 조건들은 queryParameter를 사용하는 것을 볼 수 있었습니다. 또RESTAPI 관련 문서의 bestPractice에서도 queryParameter를 사용하는 것을 지향한다. 라고 적혀있는 것을 볼 수 있었습니다. 다만 그 이유에 대해서 찾아볼 수가 없어서 질문을 올리게 되었습니다. 위의 bestPractice와 같이 코드를 작성하게 되면 다음과 같이 작성이 될 것 같습니다.@GetMapping("/boards") public Page callBoard(@ModelAttribute BoardRequestParam param, Pageable pageable){ return boardRepository.callByPaging(pageable, param); } public class BoardRequestParam { private String category; private int sort; getter... setter... }그리고 URI는 다음과 같을 것으로 예상됩니다. /boards?category=tip&sort=1&page=2&size=10질문에 대한 결론입니다! 정렬, 검색, 필터링, 페이징에 관한 내용을 REST API로 처리하지 않고 QueryParameter를 써야하는 이유가 궁금합니다! 아직도 질문하는 법이 어렵네요ㅠㅠ 질문에 대한 답변 말고도 어떻게 질문하는 것이 좋았겠다 하는 것에 대한 피드백도 부탁드립니다!답변들 감사합니다! REST API가 디자인 패턴처럼 사용하면 좋다~ 라는 느낌으로 규격같은 거라는 것은 인지하고 있습니다! 궁금해서 여러 방면으로 계속 찾아봤는데, 다음과 같은 이유가 있었습니다. 예전에는 GET에 Body를 담아서 보낼 수 없었다. 그러나 이후 GET에 body를 담아서 보낼 수 있도록 변경되었다.그러나 아직 GET 요청에서 Body를 읽지 못하는 서버 프레임워크가 존재한다.그래서 범용성을 위해 권장하지 않는다.추가적으로 SEO(Search Engine Optimization)의 측면에서 사용자가 많이 사용한 주소를 더 활용 할 수 있어서 검색 측면에서의 장점도 있다.위 추가 내용 말고도 혹시 또 다른 이유가 있으면 답변 부탁드립니다!

오후 · Accepted Answer

REST 규약은 정해진답이 없습니다.(기본적인 정의만 있고 이를 이용해 다수가 이러한 방식으로 만들자 정도)그리고 물어보신 검색,필터링,페이징처리등을 파라매터로 하는이유는REST 기본정의상 자원이름기반으로 URI(URL) 를만들고 method 로 행위를 컨트롤하는 형태이다보니필터,페이징등이들어갈경우 기본적인 정의자체랑 맞지않습니다.추가적으로도 URI(URL) 명명규칙자체가 너무길어지고 parameter 추가,삭제에대한 대응에대한 리소스가 너무많아집니다.ex) /board/{category}/{sort}/{page}/{size}/{filter1}/{filter2}/{filter3} ........ > filter 2 를 미사용 or 신규 필터가 추가될시 수정요소가 많아짐

동도인 · Answer

저도 REST API 에 대해 많이 아는 것 은 아니지만 REST API 는 일종의 규격 같은 거라서 지켜도 되고 안지켜도 되는걸로 압니다. 결국 개발자 의 마음 아닐까요. 지키면 좋다 이지 꼭 지켜 야 한다 이런건 아니니까요.

[object Object] · Answer

RESTful은 윗분 말처럼 규격같은거지 꼭 지켜야하는 것은 아니고,저는 컨트롤러에서 바로 사용 되는 변수는 &#64;PathVariable을 쓰는게 편해서 종종 사용합니다.

API 통신에서의 QueryParameter

3개의 답변

#requestbody 목록