🖋 @Controller와 @RestController 차이
@RestController는 @Controller + @ResponseBody
실제로 @Controller+@ResponseBody를 같이 쓰면 @RestController 대신으로 사용할 수 있다.
@ResponseBody 란?
@ResponseBody란 한 마디로 해당 어노테이션이 선언되면 해당 메소드의 반환 값을 웹, 즉 http 응답 body에 넣어준다는 것이다.
@ResponseBody를 붙이지 않고 @Controller만 사용했을 경우 컨트롤러는 자신을 호출했던 클라이언트 쪽으로 View와 Model을 별도로 반환한다.
즉, 보여줄 화면인 View와 그 화면에서 사용할 데이터인 Model만을 반환하는 것이다.
이러한 Controller 선언은 프론트와 백엔드가 합쳐진 웹 개발을 할 때에는 유용하다.
그러나 백엔드만 따로 개발하는 경우에는 굳이 뷰를 클라이언트쪽으로 보내주지 않아도 된다.
즉, 데이터만 클라이언트에서 사용할 수 있게 보내주면 되는데 이 때 @ResponseBody가 필요한 것이다.
@ResponseBody를 사용하면 응답 값의 body에 컨트롤러에서 반환했던 객체가 Json 형태로 들어가게 된다.
그러면 클라이언트는 json 형태로 데이터를 받아서 마음대로 사용할 수 있다. 컨트롤러에서는 따로 뷰에 대해서는 생각하지 않아도 되는 것이다.
🖋 REST API
REST 의 특징
1. Uniform (유니폼 인터페이스)
URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처이다.
2. Stateless (무상태성)
REST의 무상태성은 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다는 말이다. 세션정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
3.Cacheable (캐시 가능)
REST의 가장 큰 특징 중 하나는 HTTP 웹표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용한다. 따라서 HTTP가 가진 캐싱기능이 적용된다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능해진다.
4. Self-descriptiveness (자체 표현 구조)
REST API 메세지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어있다.
5. Client - Server 구조
REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어든다.
6. 계층형 구조
REST 서버는 다중계층으로 구성될 수 있으며 보안, 로드밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.
🖋 REST API 디자인 가이드
🚩 1. URI는 정보의 자원을 표현해야 한다.
리소스명은 동사보다는 명사를 사용하자
GET /members/delete/1
위와 같은 방식은 REST를 제대로 작용하지 않은 URI이다. URI는 자원을 표현하는데 중점을 두어야 하며 delete와 같은 행위가 들어가서는 안된다.
DELETE /members/1
따라서 다음과 같이 URI를 수정할 수 있다.
🚩 2. 자원에 대한 행위는 HTTP Method(GET,POST,PUT,DELETE)로 표현한다.
| METHOD | 역할 |
|---|---|
| POST | POST를 통해 해당 URI를 요청하면 리소스(데이터)를 생성한다. |
| GET | GET을 통해 해당 리소스(데이터)를 조회한다. 조회된 리소스 정보를 가져온다. |
| PUT | PUT을 통해 해당 리소스(데이터)를 수정한다. |
| DELETE | DELETE를 통해 해당 리소스(데이터)를 삭제한다. |
3. URI 설계 시 주의할 점
- 슬래시 구분자(/)는 계층 관계를 나타내는데 사용
http://restapi.example.com/houses/apartments
http://restapi.example.com/animals/mammals/whales- URI 마지막 문자로 슬래시(/)를 포함하지 X
- 하이픈(-)은 URI 가독성을 높이는데 사용
- 밑줄(_)은 URI에 사용하지 X
- URI 경로에는 소문자 사용
- 파일 확장자는 URI에 포함시키지 X
http://restapi.example.com/members/soccer/345/photo.jpg ❌4. 리소스 간의 관계 표현
리소스명/리소스ID/관계가 있는 다른 리소스명
일반적으로는 리소스가 다른 리소스를 소유(has) 관계일 때 사용한다.
GET : /users/{userid}/devices 복잡한 관계에 대한 구체적인 표현이 필요할 때
이 경우 리소스ID와 다른 리소스 사이에 명시적으로 표현해줄 수 있다.
GET : /users/{userid}/likes/devices예시: 사용자가 좋아하는 디바이스 목록 5. 자원을 표현하는 Collection과 Document
💎Document : 단순한 문서, 혹은 한 객체
💎Collection: 문서들의 집합, 객체들의 집합
Collection과 Document는 모두 리소스라고 표현할 수 있으며 URI에 표현된다.
http:// restapi.example.com/sports/soccer/players/13예시를 보면 sports, players 컬렉션과 soccer,13(13번 선수) 도큐먼트로 URI가 이루어진다. 컬렉션은 복수로 사용하는 것이 직관적이다.
🖋 HTTP 응답 상태 코드
| 상태코드 | 내용 |
|---|---|
| 200 | 클라이언트의 요청을 정상적으로 수행함 |
| 201 | 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시) |
| 상태코드 | 내용 |
|---|---|
| 400 | 클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드 |
| 401 | 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드 - (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때) |
| 403 | 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드 |
| 405 | 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드 |
| 상태코드 | 내용 |
|---|---|
| 301 | 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드 - (응답 시 Location header에 변경된 URI를 적어 줘야 함) |
| 500 | 서버에 문제가 있을 경우 사용하는 응답 코드 |
