💡RESTful API

주니어 개발자의 개인 공부 과정을 기록합니다.

RESTful API

RESTful API?? RESTful URL?? 많이 들어는 봤는데,, 정확하게 모르겠다.🥲
현재 사용되고 있는 API 설계 규칙 가운데 가장 널리 사용되고 있는 규칙이라고 하니 이번 기회에 정리해보자!

REST?

REST(REpresentational State Transfer)란 웹에 존재하는 모든 자원(resorce, ex. 이미지, 동영상, 데이터)에 고유한 URI를 부여하여 자원에 대한 주소를 지정하는 방법론, 또는 규칙
> RESTful API는 REST 특징을 지키면서 API를 제공한다는 의미이다.

RESTful API란?

• REST 특징을 지키면서 정보를 주고받는 데에 개발자들 사이에 널리 쓰이는 일종의 형식.
  • REST: 웹에 존재하는 모든 자원에 고유한 uri을 부여하는 방법
    • URI: 자원을 구조와 함께 나타내는 형식의 구분자
  • API: 어떤 소프트웨어가 다른 소프트웨어로 부터 지정된 형식으로 요청, 명령을 받을 수 있는 수단 ex. Web API, windows API 등

조금 더 풀어보면, “프론트엔드에서 백엔드 API를 호출할 때 url을 어떻게 만들 것인가?” 정도로 설명할 수 있다.

REST API의 특징

• 각 요청이 어떤 동작이나 정보를 위한 것인가를 그 요청의 모습 자체로 추론 가능하다
• 서버로 REST API 요청을 보낼 때는 HTTP 규약에 따라 신호를 전송하는데, REST API는 GET, POST, DELETE, PUT, PATCH 메소드를 사용한다
  • POST <span style=“color:blue”>C</span>reate
  • GET <span style=“color:blue”>R</span>ead
  • PUT <span style=“color:blue”>U</span>pdate 정보를 통째로 변경할 때
  • PATCH <span style=“color:blue”>U</span>pdate 일부 정보만 변경할 때
  • DELETE <span style=“color:blue”>D</span>elete

REST API의 장점

• 원하는 타입으로 데이터를 주고 받을 수 있다.
• Open API 를 제공하기 쉽다
• 기존 웹 인프라(HTTP)를 그대로 사용할 수 있다.

REST API의 단점

• 사용할 수 있는 메소드가 4 가지 밖에 없다.
• HTTP 통신 모델에 대해서만 지원한다.

---

✨ tl;dr

✔️ REST API란?

• 정보를 주고받는 데에 있어서 개발자들 사이에 널리 쓰이는 일종의 형식
• 각 요청이 어떤 동작이나 정보를 위한 것인가를 그 요청의 모습 자체로 추론 가능하다

✔️ RESTful 하게 API를 디자인 한다는 것은?

• 리소스와 행위를 명시적이고 직관적으로 분리한다.
  • 리소스는 URI로 표현되는데 리소스가 가리키는 것은 명사로 표현되어야 한다.
  • 행위는 HTTP Method로 표현하고, GET(조회), POST(생성), PUT(기존 entity 전체 수정), PATCH(기존 entity 일부 수정), DELETE(삭제)을 분명한 목적으로 사용한다.
• Message는 Header와 Body를 명확하게 분리해서 사용한다.
  • Entity에 대한 내용은 body에 담는다.
  • 애플리케이션 서버가 행동할 판단의 근거가 되는 컨트롤 정보인 API 버전 정보, 응답받고자 하는 MIME 타입 등은 header 에 담는다.
  • header와 body는 http header 와 http body 로 나눌 수도 있고, http body 에 들어가는 json 구조로 분리할 수도 있다.
• 서버와 클라이언트가 같은 방식을 사용해서 요청하도록 한다.
  • 브라우저는 form-data 형식의 submit 으로 보내고 서버에서는 json 형태로 보내는 식의 분리보다는 json 으로 보내든, 둘 다 form-data 형식으로 보내든 하나로 통일한다.