spring

GET API

ydaeng 2024. 9. 13. 01:22
GET API
자원을 조회하기 위해 사용되는 API

 

@RequestMapping
  • value와 method로 정의하여 api를 개발하는 방식
  • value는 URI, method는 HTTP Method를 지정
  • 예) localhost:8080/hello

 

@GetMapping
  • GET API를 호출하는 경우 사용
  • 'value=' 생략 가능

 

@PathVariable
  • GET 요청은 파라미터를 전달하기 위해 URL에 값을 담아 요청
  • URL에서 담긴 값과 변수를 매핑하기 위해서 사용
  • 예) localhost:8080/hello/daeng

  • @GetMapping value 표현 내 {value}와 @PathVariable 변수 이름이 일치하는 경우 value값 지정 생략 가능

 

@RequestParam
  • GET 요청에서 쿼리 문자열을 전달하기 위해 사용되는 방식
  • URL에서 '?' 우측으로 'key=value'의 형태로 표현하고 복수의 경우 '&'로 연결
  • 예) localhost:8080/hello?name=daeng?animal=rabbit

  • 어떤 값이 들어올지 알고 있는 경우, key=value가 정해진 경우 파라미터를 통해 매핑 가능

 

DTO
  • GET 요청에서 쿼리 문자열을 매핑할 때 key=value가 정해져 있지만 파라미터가 많은 경우 DTO 객체 사용
  • 예) localhost:8080/hello?name=daeng&animal=rabbit&age=1
  • name, animal, age key에 대한 value를 저장한 DTO를 전달