REST API란?

Server API

적절한 요청이 보내지면 그에 맞는 응답을 각 url을 통해 돌려주는 것.

종류

• REST API
• GraghQL API
• grpc

 

REST (Representational State Transfer)

자원(해당 소프트웨어가 관리하는 모든 것, ex-데이터 하나하나, 이미지 하나하나)을 이름으로 구분하여 해당 자원의 상태를 주고 받는 (JSON형태나 XML 형태를 이용하여 자원의 상태를 전달) 모든 것

REST는 Representational State Transfer의 약자이다. 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든것들을 의미한다. URI를 통해 자원(Resouce)을 명시하고 HTTP Method(GET, POST, PUT, PATCH, DELETE 등)를 통해 해당 자원에 대한 CRUD를 적용하는 것을 의미한다.

⇒ 웹에 존재하는 모든 자원(이미지, 동영상, DB 자원)에 고유한 URI를 부여해 활용하는 것으로, 자원을 정의하고 자원에 대한 주소를 지정하는 방법론

⇒ URL, METHOD등을 조합하기 때문에 각 resource마다 하나의 Endpoint가 존재한다.

• Endpoint : API가 서버에서 리소스에 접근할 수 있도록 가능하게 하는 URL이다

 

REST의 구성요소

• 자원
• 모든 자원은 고유 id가 있으며 server에 존재한다.
• 행위
• client는 HTTP 메소드(POST, GET, DELETE, PUT)를 이용하여 지정한 자원에 대한 조작을 요청한다.
• 표현
• Client가 Server에 자원에 대한 조작을 요청하면 server는 이에 대한 적절한 응답을 보낸다.

 

특징

1. 유니폼 인터페이스한정적인 인터페이스 : params대신 HTTPS Method를 사용하는 한정적인 인터페이스를 사용하면 URL길이가 짧아지고 하나의 URL로 많은 표현을 할 수 있다.
2. Client가 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 의미한다.
3. 무상태성따라서 서비스의 자유도가 높아지고, 서버에서 불필요한 정보를 관리하지 않기 때문에 구현이 단순해짐.
4. 작업을 위한 상태정보를 별도로 저장하거나 관리하는 일을 하지 않음. 즉 콘텍스트(쿠키와 세션) 정보를 별도 저장하지 않고 서버로 들어오는 요청을 처리하기만 하면된다.
5. 캐시 가능
6. 웹 표준인 HTTP를 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 사용할 수 있다. 따라서 HTTP가 가진 캐싱 기능을 적용할 수 있다.
7. 자체 표현 구조예를 들어, REST API가 velog.io/@govl6113/car/kia/k3 이면 이것만 보고도 k3는 car종류의 kia 차라는 것을 알 수 있다.
8. REST API만 보고도 이를 쉽게 이해할 수 있다.
9. Client - Server 구조
10. client는 세션, 로그인 정보등 직접관리하고 사용자 인증을, server는 api제공 등 역할이 명확히 나뉘어 개발할 점이 명확해지고 서로간 의존성이 줄어듦.
11. 계층형 구조
12. REST 서버는 다층 계층으로 구성될 수 있으며 보안, 암호화 계층 등을 추가할 수 있다.

 

단점

• 이미 정해놓은 구조로만 응답이 온다.
• 필요한 resource가 여러 개면 각 resource별로 요청을 해야 한다.
• 응답 구조가 정해져있어서 부분적으로 요청할 수 없다.

 

REST API 디자인 가이드 (사용법)

1. URL은 정보의 자원을 표현해야 한다.
2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

중심 규칙

1. URL은 정보의 자원을 표현해야 한다. ⇒ 리소스명은 동사보다 명사
2. GET /members/delete/1
3. 자원을 표현해야하기 때문에 delete같은 행위에 대한 표현이 URL에 들어가면 안된다.
4. 자원에 대한 행위는 HTTP Method로 표현한다.위의 예시를 고쳐본다면, 아래가 맞다.
5. DELETE /members/1
6. HTTP Method : GET(조회), POST(생성), PUT(수정), DELETE(삭제)

 

사용할 때

• 요청의 구조가 정해져있을 때
• file전송 등 단순한 text로 처리되지 않는 요청들이 있을 때

 

---

[참고]

https://blog.metafor.kr/165

https://velog.io/@kjh107704/REST-서버-REST-API란