API의 구현과 API 명세서-2

API 구현과 API 명세서 - 2

RequestMapping을 이용한 HTTP method 처리 구현

---

• @RequestMapping
  • HTTP 메서드와 Controller의 메서드를 연결하는 가장 기본적인 방법
  • 파라미터에 URL과 HTTP메서드의 종류를 전달하여 연결함.
• @PostMapping
  • POST 요청과 Controller의 메서드를 연결하는 방법.
  • 파라미터에 URL을 전달하여 연결함.
  • 메서드의 파라미터에 @RequestBody 어노테이션을 추가하여 POST 요청의 body를 자바 객체로 받아옴
• @GetMapping
  • Get요청과 Controller의 메서드를 연결하는 방법
  • 파라미터에 URL을 전달하여 연결함.
  • @PathVariable 또는 @RequestParam 어노테이션을 이용하여 쿼리스트링을 자바의 문자열로 받아옴
  • @PathVariable
    • 주로 특정 리소스를 조회하는데에 사용
  • @RequestParam
    • 주로 검색기능의 검색 조건을 전달하기 위해 사용
• @PutMapping
  • PUT요청과 Controller의 메서드를 연결하는 방법
  • @PathVariable을 통해 덮어쓰기를 진행할 리소스의 식별자 등을 전달
  • @RequestBody를 통해 덮어쓰거나 생성할 리소스의 데이터를 전달
• @PatchMapping
  • PATCH 요청과 Controller의 메서드를 연결하는 방법
  • @PathVariable을 통해 수정을 진행할 리소스의 식별자 등을 전달
  • @RequestBody를 통해 수정할 리소스의 데이터를 전달
• @DeleteMapping
  • DELETE 요청과 Controller의 메서드를 연결하는 방법
  • 파라미터에 URL을 전달하여 연결
  • @PathVariable을 통해 삭제를 진행할 리소스의 식별자 등을 전달

API 명세서 예시