REST API디자인을 하기 위해서 자원에 대한 행위들은 HTTP Method로 표현을 해야한다. HTTP Method에는 GET, POST, PUT, DELETE 등이 존재한다.
오늘은 Spring Boot에서 GET API를 사용하는 방법에 대해 알아볼 것이다.
GET API의 특징
- 리소스를 취득하는 작업을 하는 API이다.
- CRUD에서 R에 해당한다.
- 값을 읽어오기만하여 멱등성과 안정성이 있다는 특징이 있다.
- Path Variable을 사용가능하다.
- Query Parameter도 사용가능하다.
사용되는 Annotation의 종류
- @RestController
해당 annotation을 추가해주면 해당 class는 REST API를 처리하는 controller로 등록이 된다. - @RequestMapping(path)
리소스를 설정하는 코드이며 괄호안에 입력하는 값에 따라 URI가 localhost:8080/path로 설정된다. - @GetMapping(path)
Get API를 해당 uri로 mapping시켜준다. - @PathVariable
변화하는 구간에 사용하는 annotation이며 URL path를 parsing해준다. - @RequestParam
URL에 Query문을 추가할 때 parameter를 parshing해준다.
GET API사용하기
GetMapping사용하기
@RestController
@RequestMapping("/api/get")
public class GetApiController {
// http://localhost:9090/api/get/hello
@GetMapping(path = "/hello")
public String Hello(){
return "get Hello";
}
}
Spring boot가 처음이기에 코드에 대해 처음부터 설명을 하며 정리를 해보려한다.
먼저 Class를 생성하는 코드부터 보겠다. 코드의 첫번째 줄인 @RestController은 해당 annotation을 추가해주면서 해당 class는 REST API를 처리하는 controller로 등록을 한다.
두전째 줄인 @RequestMapping("/api/get")은 URI를 지정해주는 annotation이다.
이렇게 @RestController, @RequestMapping("/api/get")를 통해 GetApiController class는 기본 uri를 http://localhost:8080/api/get 로 갖으며 REST API를 처리하는 controller로 생성되었다.
다음으로 Method를 확인해보겠다. Method위에 추가된 @GetMapping(path = "/hello")라는 annotatin은 GET 요청이 path로 들어오면 해당 method를 mapping시켜주겠다는 의미를 가진다. 위의 코드의 경우는 기본 주소인 http://localhost:8080/api/get에 path인 /hello를 추가하여 http://localhost:9090/api/get/hello 로 GET request가 들어오면 method가 실행되고 결과인 "get Hello"를 return해주게 된다.
@GetMapping은 기본적으로 괄호안에 ("/hello")라고 입력을 해도 괄호 안의 값을 value값으로 인식을 해서 path = "/hello"와 같은 결과를 내게 된다. 그래서 path는 꼭 써주지 않아도 된다.
@RequestMapping(path = "/hi", method = RequestMethod.GET)
public String hi(){
return "get hi";
}위의 코드는 과거에 사용하던 방식으로 RequestMapping을 하면 Get, Post, Put, Delete가 모두 동작한다. 위와 같이 Get만 사용하도록 지정하고 싶다면 method parameter를 추가해주면 된다.
PathVariable 사용하기
@GetMapping("path-variable/{name}")
public String pathVariable(@PathVariable String name){
// 일반적으로 34번,35번,38번 line의 변수명(name)이 같아야한다.
System.out.println("PathVariable : " + name);
return name;
}사용자의 이름, 아이디 등 변할 수 있는 정보를 URI에 넣어야 한다면 개발자는 같은 method를 각각의 path를 마다 생성해줘야 할 것이다. 하지만 이것은 매우 비효율적인 개발 방법이며 이러한 일을 해결해 주는 것이 PathVariable이다. 변화하는 구간에 대해서는 PathVariable을 사용해야한다.
PathVariable은 @GetMapping의 Path를 "path-variable/{name}"와 같이 변경될 수 있는 부분을 { }로 지정해주며 사용한다. { }안에는 변수명을 적으며 method의 parameter에 @PathVariable 변수명을 입력하며 { }에 들어가는 값을 읽어온다.
위의 코드의 경우는 http://localhost:8080/api/get/path-variable/seongwon 이라는 URI로 request가 왔다면 name은 seongwon이 되며 return될 것이다.
@GetMapping("path-variable/{name}")
public String pathVariable(@PathVariable(name = "name") String pathName){
System.out.println("PathVariable : " + pathName);
return pathName;
}프로그래밍을 하다보면 변수가 꼬여 PathVariable의 변수명을 다르게 설정해야하는 상황이 생길 수도 있다. 그러한 경우에는 위의 코드와 같이 method parameter에 @PathVariable에 (name=~~)와 같이 지정을 하며 다른 변수명을 사용할 수도 있다.
Query Parameter 사용하기
https://www.google.com/search?q=velog.&oq=velog.&aqs=chrome..69i57j0i512l2j0i30j69i60l4.4182j0j4&sourceid=chrome&ie=UTF-8 다음 주소를 한번 확인해보자.
Query parameter는 위의 주소에서 search? 부터의 주소를 의미한다. 즉, 검색을 할 때 여러가지 매개변수들을 의미한다.
위의 주소를 자세히 보면 중간 중간 and 연산자가 있다.
한번 Query parameter를 &로 나눠서 보도록 하자
search?q=velog.
&oq=velog.
&aqs=chrome..69i57j0i512l2j0i30j69i60l4.4182j0j4
&sourceid=chrome&ie=UTF-8
& 단위로 나눠서 본 URI를 확인해보면 처음에 Search이후 ?로 시작을 하여 key=value의 형식으로 문장이 이어지는 것을 확인할 수 있다.
Query parameter는 즉 Key, value값으로 이루어진 연속된 query문으로 이루어진 것을 알 수 있다.
이제 Query parameter를 받는 방법을 알아보도록 하자.
@GetMapping(path = "query-param01")
public String queryParam01(@RequestParam Map<String, String> queryParam){
// key=value값으로 데이터를 받기에 Map으로 구현
StringBuilder sb = new StringBuilder();
queryParam.entrySet().forEach( entry -> {
System.out.println(entry.getKey());
System.out.println(entry.getValue());
System.out.println("\n");
sb.append(entry.getKey()+ " = "+entry.getValue()+"\n");
});
return sb.toString();
}위의 코드는 Map을 활용하여 Key, value값을 받아온 코드이다.
하지만 위의 코드의 경우는 Key값들이 무엇이 있는지 코드상으로 명확하게 알 수가 없다.
아래와 같이 @RequestParam을 여러번 사용하여 Key값을 지정하고 값을 받아오면 Query parameter에서 사용하는 key값들을 미리 알고 지정할 수 있다.
@GetMapping(path = "query-param02")
public String queryParam02(@RequestParam String name,
@RequestParam String email,
@RequestParam int age){
System.out.println(name);
System.out.println(email);
System.out.println(age);
return name+ "\n" + email+ "\n"+age;
}마지막 방법은 객체를 미리 정의하고 사용하는 방법으로 현재 사람들이 가장 많이 사용하는 방법이다.
Request DTO(객체)를 미리 만들어 사용하는 방법은 이전 방식과 다르게 @RequestParam을 붙이지 않는다.
코드의 동작 원리는 다음과 같다. Spring boot에서는 parameter로 객체가 들어오면 "?user=steve&email=steve@gmail.com&age=30"와 같은 query parameter에 있는 객체들을 spring boot에서 판단을 하고 key에 위치한 값들을 객체의 변수의 이름과 매칭을 해주며 작동을 한다.
@GetMapping(path = "query-param03")
public String queryParam03(UserRequest userRequest){
// 이전 방식과 다르게 @RequestParam을 붙이지 않는다.
// Spring boot에서는 parameter로 객체가 들어오면
// "?user=steve&email=steve@gmail.com&age=30"와 같은
// query parameter에 있는 객체들을 spring boot에서 판단한다.
// 그리고 key에 위치한 값들을 객체의 변수의 이름과 매칭을 해준다.
System.out.println(userRequest.getName());
System.out.println(userRequest.getEmail());
System.out.println(userRequest.getAge());
return userRequest.toString();
}결론
지금까지 GET API의 사용법에 대해 알아보았다. Spring boot를 처음 공부하다보니 기본적인 Annotation의 기능 설명까지 하다보니 글이 길어지게 되었다. GET API를 공부를 시작하며 URI의 구조부터 GET API의 작동법까지 많은 공부를 하게 된 것 같다. 이제 POST, PUT, DELETE를 공부하며 정리해보려한다.
