REST API
REST(Representational State Transfer) API는 REST 아키텍쳐 스타일을 준수하는 API를 나타내는 말로 REST 아키텍쳐를 적절하게 준수한 API를 RESTful API라고도 부른다.
REST 아키텍쳐는 자원(resource)를 이름으로 구분하여 해당 자원의 상태를 주고받는 것을 의미한다. 즉, HTTP URI(Uniform Resource Identifier)를 통해 자원을 명시하고 HTTP Method(POST, GET, PUT, DELETE, PATCH 등)를 통해 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 말한다.
CRUD
Create, Read, Update, Delete의 약자로 Create는 데이터 생성, Read는 데이터 조회, Update는 데이터 수정, Delete는 데이터 삭제를 의미한다.
RESTful API를 위한 CRUD와 HTTP Method의 관계
CRUD HTTP Method Create POSTRead GETUpdate PUT,PATCHDelete DELETE
PUT은 전체 수정,PATCH는 부분 수정을 위해 사용하는 Method이다.
Controller에서의 구현
@Controller어노테이션을 사용하면 Controller 객체는 ViewName을 반환하게 되고 DispatcherServlet이 ViewResolver를 통해 ViewName에 해당하는 View를 보여준다.
하지만 REST API를 구현하기 위해서는 Controller 객체가 ViewName이 아닌 JSON형태의 데이터를 반환해야 한다.
이를 위해 Controller 객체에 @ResponseBody어노테이션을 추가해주고 데이터에 대한 객체를 반환해주면 객체가 JSON 형태로 반환된다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
@Controller
@RequiredArgsConstructor
public class TestController {
private final TestService testService;
// viewName을 반환하는 기존 함수
@GetMapping("/info")
public String testViewName(Model model, @RequestParam String info) {
Test testInfo = testService.findInfo(info);
model.addAttribute("info", testInfo);
return "/info";
}
//JSON형태의 데이터를 반환
@ResponseBody
@GetMapping("/info")
public ResponseEntity<Test> testJson(@RequestParam String info) {
return ResponseEntity.ok(testService.findInfo(info));
}
}
보통 Controller로 객체를 반환할 때에는 ResponseEntity로 감싸서 반환하게 된다.
ResponseEntity?
ResponseEntity는 HTTP 요청에 대한 응답데이터 뿐만 아니라 HttpHeader와 HttpBody를 포함하는 클래스이다.
ResponseEntity의 생성자에는 상태 코드(status), 응답 헤더(header), 응답 데이터(body)가 있고 필요에 따라 원하는 응답을 출력할 수 있다.
@Controller어노테이션과 @ResponseBody어노테이션을 통합한 @RestController를 사용하면 아래와 같이 더 간결하게 코드를 작성할 수 있다.
1
2
3
4
5
6
7
8
9
10
@RestController
@RequiredArgsConstructor
public class TestController {
private final TestService testService;
@GetMapping("/info")
public ResponseEntity<Test> testJson(@RequestParam String info) {
return ResponseEntity.ok(testService.findInfo(info));
}
}
POST
주로 새로운 리소스를 생성하는 데에 사용되며 requestBody에 key-value형식으로 데이터를 입력하여 전달한다.
GET과 달리 URI에 데이터가 노출되지 않기 때문에 보안상의 이점이 있으며, 데이터를 body에 넣어서 전송하기 때문에 전송할 데이터의 길이에 대한 제한이 없다.
1
2
3
4
5
6
7
8
9
10
@RestController
@RequiredArgsConstructor
public class TestController {
private final TestService testService;
@PostMapping("/info")
public ResponseEntity<Test> testJson(@RequestBody RequestDto info) {
return ResponseEntity.ok(testService.saveInfo(info));
}
}
GET
리소스를 조회할 때에 사용되며 URI에 Query parameter 또는 Path variable 방식으로 리소스를 식별하기 위한 데이터를 전달한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@RestController
@RequiredArgsConstructor
public class TestController {
private final TestService testService;
// query parameter방식 -> GET | http://kymin.com/info?id=1
@GetMapping(path = "/info", params = id)
public ResponseEntity<Test> testQueryParams(@RequestParam String id) {
return ResponseEntity.ok(testService.findInfo(id));
}
// path variable -> GET | http://kymin.com/info/1
@GetMapping("/info/{id}")
public ResponseEntity<Test> testPathVariable(@PathVariable String id) {
return ResponseEntity.ok(testService.findInfo(id));
}
}
Query parameter는 보통 검색어와 같이 동적 데이터를 전달 받을 경우에 사용하며 Path variable은 정적인 데이터를 전달하는 데에 사용한다.
PUT
기존에 존재하는 리소스를 수정할 때 사용하며 요청을 통해 전달받은 데이터를 기존의 데이터에 덮어쓰는 개념이다.
요청 형태는 GET과 POST가 합쳐진 형태이다.
1
2
3
4
5
6
7
8
9
10
@RestController
@RequiredArgsConstructor
public class TestController {
private final TestService testService;
@PutMapping("/info/{id}")
public ResponseEntity<Test> testJson(@PathVariable int id, @RequestBody RequestDto info) {
return ResponseEntity.ok(testService.changeInfo(info));
}
}
PATCH
기존에 존재하는 리소스를 부분적으로 수정할 때 사용하며 전달받은 데이터가 기존 리소스에 존재하지 않는다면 반영하지 않는다.
요청 형태는 GET과 POST가 합쳐진 형태이다.
1
2
3
4
5
6
7
8
9
10
@RestController
@RequiredArgsConstructor
public class TestController {
private final TestService testService;
@PatchMapping("/info/{id}")
public ResponseEntity<Test> testJson(@PathVariable int id, @RequestBody RequestDto info) {
return ResponseEntity.ok(testService.changeInfo(info));
}
}
PUT과 PATCH의 차이
PUT은 기존 리소스를 전달 받은 데이터로 덮어쓰기하는 방식이고 PATCH는 기존 리소스의 데이터를 일부만 변경한다는 것이 차이점이다.
// 기존 데이터 { "id" : 1, "name" : "kymin", "number" : "2" }PUT 메서드를 이용하여 기존 데이터를 수정하면 기존 리소스는 아래와 같이 변경된다.
// PUT | http://kymin.com/info?id=1 { "name" : "kyoung-min" } // 결과 { "id" : 1, "name" : "kyoung-min", "number" : null }PUT 메서드는 전달받은 데이터를 모두 덮어쓰기 때문에 전달받지 않은 데이터인
number의 경우에는 null이 덮어스기 된 것을 알 수 있다.PATCH 메서드를 이용하여 기존 데이터를 수정하면 기존 리소스는 아래와 같이 변경된다.
// PATCH | http://kymin.com/info?id=1 { "name" : "kyoung-min" } // 결과 { "id" : 1, "name" : "kyoung-min", "number" : "2" }PATCH 메서드는 전달 받은 데이터를 일부 수정하기 때문에 전달받지 않은 데이터인
number의 경우 수정되지 않은 것을 알 수 있다.이외에도 수정 요청이 발생한 리소스가 존재하지 않을 경우에 PUT 메서드를 통해 요청받으면 새로운 리소스를 생성하여 요청받은 데이터를 저장하게 되는 반면에 PATCH 메서드를 통해 요청받으면 새로운 리소스가 생성되지 않고 에러가 발생하게 된다.(PATCH 메서드는 일부 요청이므로 리소스 생성에 필요한 모든 데이터를 가지고 있지 않을 수도 있기 때문이다.)
DELETE
리소스를 삭제하는 데에 사용되며 삭제하려는 리소스가 존재하지 않더라도 결과적으로 데이터가 존재하지 않기 때문에 에러가 발생하는 대신 정상 처리 응답이 발생한다.
1
2
3
4
5
6
7
8
9
@RestController
@RequiredArgsConstructor
public class TestController {
private final TestService testService;
@DeleteMapping("/info/{id}")
void deletePost(@PathVariable int id) {
service.deleteInfo(id);
}
}