멀티캠퍼스 [현대 이지웰] REST와 REST API란??

REST란?

REST는 REpresentational State Transfer의 약자로, 웹 서비스를 설계하기 위한 아키텍처 스타일 즉,

설계 원칙 모음입니다. 기술이나 표준이 아니라, "이렇게 만들면 웹의 장점을 최대한 활용하는 좋은 서비스를 만들 수 있다"라고

제시하는 일종의 가이드라인입니다.

 

REST의 핵심 아이디어는 웹에 존재하는 모든 것을 자원(Resource)으로 보고, 자원을 고유한 주소(URI)로 식별하며,

정해진 방식(HTTP Method)으로 자원의 상태를 주고받는 것입니다.

 

REST를 구성하는 6가지 핵심 원칙

이 원칙들을 지켜야 'RESTful' 하다고 말할 수 있습니다.

1. 클라이언트-서버 구조

- 자원을 요청하는 클라이언트와 자원을 관리하는 서버의 역할을 명확히 분리합니다.

- 서버는 UI나 사용자 상태에 신경 쓰지 않고, 클라이언트는 서버의 데이터 저장 방식에 신경쓰지 않아도 됩니다.

2. 무상태성

- 서버는 클라이언트의 이전 요청 상태를 저장하지 않습니다.

- 모든 요청은 그 자체로 완전해야 하며, 서버가 요청을 처리하는 데 필요한 모든 정보를 담고 있어야 합니다.

- 이 덕분에 서버는 클라이언트의 상태를 관리할 필요가 없어 단순해지고, 어떤 서버가 요청을 처리하든 상관 없어져 확장성이 매우 높아집니다.

3. 캐시 가능성

- 서버는 응답 데이터가 캐시(임시저장)될 수 있는지 여부를 명확히 명시해야 합니다.

- 클라이언트는 캐시 가능한 데이터를 재사용하여 불필요한 요청을 줄이고, 성능과 응답 속도를 향상 시킬 수 있습니다.

4. 계층화 시스템

- 클라이언트는 API 서버와 직접 통신하는지, 중간의 프록시 서버나 로드밸런서를 거치는지 알 수 없습니다.

- 서버 구조를 여러 계층으로 나누어 보안, 부하 분산 등을 유연하게 구출할 수 있습니다.

5. 일관된 인터페이스

- 자원의 식별(URI): 모든 자원은 /books/1과 같은 고유한 주소로 식별되어야 합니다. URI는 동사가 아닌 명사를 사용합니다.

- HTTP 메서드를 통한 자원 조작: 자원을 다룰 때는 GET(조회), POST(생성), PUT(수정), DELETE(삭제)와 같은 HTTP 메서드를 사용합니다.

6. 주문형 코드

- 서버가 클라이언트에게 실행 가능한 코드(예: JavaScript)를 보내주면, 클라이언트가 그것을 실행할 수 있다는 원칙입니다.

 

REST API란?

REST API는 위에서 설명한 REST 설계 원칙을 충실히 따르는 API를 의미합니다. 'RESTful API'라고도 부릅니다.

REST API는 HTTP 프로토콜의 잠재력을 최대한 활용하여 자원을 명확하게 표현하고 조작합니다.

 

REST API의 핵심 요소

1. 자원(Resource) - URI

- API가 다루는 모든 것을 명사로 표현합니다.

- Ex) book -> /books : 모든 도서목록, /books/123: ID가 123인 특정 도서

 

2. 행위 - HTTP Method

- 자원에 대한 행위는 HTTP 메서드로 표현합니다.

- GET: 자원 조회 (/books, /books/123)

- POST: 자원 생성 (/books)

- PUT: 자원 전체 수정 (/books/123)

- PATCH: 자원 일부 수정 (/books/123)

- DELETE: 자원 삭제 (/books/123)

 

 

스프링에서는 어노테이션을 사용하여 매수 쉽게 REST API를 만들 수 있습니다.

1. RestController

- 클래스 레벨에 붙이는 어노테이션으로, @Controller와 @ResponseBody를 합친 것입니다.

- 이 어노테이션이 붙은 클래스의 모든 메서드는 반환 값을 View 이름으로 해석하지 않고, 응답 본문에 직접 JSON이나 텍스트 형태로 작성합니다. Aiax 요청에 응답할 때 필수적입니다.

 

@Controller를 사용하면 아래 메소드들이 View 페이지를 반환할 수 있고, @ResponseBody를 메소드에 넣으면 데이터 값을 반환할 수 있게 됩니다.

하지만 @RestController를 사용하게 된다면 무조건 메소드들은 데이터값을 반환하게 됩니다.

Controller와 RestController의 차이점입니다.

 

2. HTTP 메서드 매핑 어노테이션

@RequestMapping을 더 구체화한 어노테이션들입니다.

 

 

 

역할: 특정 URL 주소와 컨트롤러의 메서드를 연결(매핑)하는 어노테이션입니다.

@RequestMapping("/product/listAllProduct")를 작성하게 되면 /product/listAllProduct 라는 URL로 들어오는 요청을 

listProduct() 메서드와 연결합니다. 이 부분에서 return 값을 보면 url처럼 보입니다. 이는 View 페이지로 넘기기 위한 값이라고 보면 됩니다.

 

 

위 사진과 같은 경우는 localhost 8080: 호출된다면 index View 페이지를 반환하라는 코드입니다.

 

- @GetMapping("/books/{id}"): GET 요청을 처리합니다.

역할: @RequestMapping(method = RequestMethod.GET)의 축약형으로, GET 방식의 HTTP 요청만 처리하도록 URL을 매핑합니다.

- @PostMapping("/books"): POST 요청을 처리합니다.

역할: @RequestMapping(method = RequestMethod.POST)의 축약형으로, POST 방식의 HTTP 요청만 처리하도록 URL을 매핑합니다.

 

두 어노테이션을 @RequestMapping 대신에 사용을 한다면 코드의 의도를 명확하게 알 수 있습니다.

(GET일 때는 주로 조회, POST일 때는 주로 생성)

 

- @PutMapping("/books/{id}"): PUT 요청을 처리합니다.

- @DeleteMapping("/books/{id}"): DELETE 요청을 처리합니다.

- @PatchMapping("/books/{id}"): PATCH 요청을 처리합니다.

 

3. 파라미터 관련 어노테이션 

- @PathVariable: URL 경로에 포함된 값(예: /books/{id}의 id)을 파라미터로 받을 때 사용합니다.

- @RequestParam: URL의 쿼리 스트링(예: /books?category=IT)을 파라미터로 받을 때 사용합니다.

- @RequestBody: 요청의 본문(Body)에 담겨온 JSON 등의 데이터를 Java 객체(DTO/VO)로 변환하여 받을 때 사용합니다.

역할: URL의 쿼리 스트링(예: ?key=value)이나 form-data 형식으로 전송된 파라미터 값을 받아옵니다.

Ajax 요청의 data: {"prdNo": "p001"} 부분에서 prdNo라는 키(key)에 해당하는 값("p001")을 찾아서 String prdNo 파라미터에 넣어줍니다.

어노테이션 @ResponseBody는 return 값이 View 페이지가 아니라 하나의 값이라는 것을 알려줍니다.

 

역할: URL 경로에 포함된 변수 값을 파라미터로 받아올 때 사용합니다.

설명: REST API에서는 /books/1처럼 URL 경로 자체에 자원을 식별하는 값을 넣는 경우가 많습니다. @PathVariable은 이 경로의 일부를 추출하는 역할을 합니다.

위 사진에서는 prdNo을 추출합니다.

 

 

 

 

 

 

역할: HTTP 요청의 본문(Body)에 담겨있는 데이터 전체를 Java 객체로 변환(역직렬화)하여 받아올 때 사용합니다.

설명: 클라이언트(웹 브라우저, 모바일 앱 등)가 새로운 데이터를 생성하거나 수정하기 위해 JSON 형식의 데이터를 요청 본문에 담아 보내는 경우가 많습니다. @RequestBody는 이 JSON 데이터를 지정된 DTO/VO 객체로 자동으로 변환해 주는 편리한 기능입니다.