[API]RESTful API

박민하·2022년 6월 22일

DJANGO

목록 보기

11/22

✅ REST

REST(REpresentational State Transfer)란 웹에 존재하는 모든 자원(resource, ex. 이미지, 동영상, 데이터)에 고유한 URI를 부여하여 자원에 대한 주소를 지정하는 방법론, 또는 규칙이다. API 시스템을 구현하기 위한 아키텍처(Graphql, SOAP, GRPC, REST, ...) 중에 현재 가장 널리 사용되고 있다.

쉽게 말하면 http의 url과 http method(GET, POST, PUT, DELETE)를 사용해서 API 가독성을 높인 구조화된 시스템 아키텍쳐(framework)이다.

RESTful API는 REST 특징을 지키면서 API를 제공한다는 의미다. 즉, 프론트엔드에서 백엔드 API를 호출할 url을 어떻게 만들것인지를 생각하는 것이다.

✅ RESTful API

장점: self-descriptiveness, RESTful API는 그 자체만으로 API의 목적이 쉽게 이해된다.
단점: 표준규약이 없어 안티패턴으로 작성되는 경우가 흔하다.
- 안티패턴: 실제 많이 사용되는 패턴이지만 비효율적이거나 비생산적인 패턴

✔ 기본 배경 지식

URI/HTTP Method/Payload

URI(Uniform Resource Identifier)

해당 사이트의 특정 자원의 위치를 나타내는 유일한 주소
ex) https://finance.naver.com/login

HTTP Method

HTTP request가 의도하는 action을 정의한 것
GET, POST, PUT, DELETE
하나의 URL로 4가지의 HTTP method를 전송할 수 있다.

Payload

HTTP request 에서 sever로 보내는 데이터(body)

✔ RESTful API 설계 규칙

URI 정보를 명확하게 표현해야 한다.

ex) /detail_page (X) -> /product (O)
ex) /main_page (X) -> /products (O)
URI은 page기준이 아닌 resource 기준으로 작성한다.
resource는 명사를 사용한다.

ex) GET user/1 -> GET users/1
resource에 대한 행위를 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.
- URI에 HTTP METHOD가 포함되어서는 안된다.
  
  ex) GET delete/user/1 -> DELETE/users/1
- URI에 동사가 포함되어서는 안된다.
  
  ex) GET user/show/1 -> GET users/1
  ex) POST user/add/product -> GET users/product
resource 사이에 연관 관계가 있는 경우: /리소스/고유ID/관계 있는 리소스

ex) GET/users/{user_id}/profile
파일의 경우 payload의 포맷을 나타내기 위한 파일 확장자를 URI를 포함시키지 않는다.

ex) GET user/1/profile-photo.jpg (X)
ex) GET user/1/profile-photo (이 때 payload의 포맷은 headers에 accept를 한다
URI는 / 구분자를 사용하여 자원의 계층 관계를 나타내는데 사용한다.

ex) POST /product_reviews (X) -> products/1/reviews (O)
ex) POST /product_filter (X) -> /product?name= (O)
URI 마지막 문자로 /를 포함하지 않는다.
불가피하게 URI가 길어지는 경우 -을 사용하여 가독성을 높인다(띄어쓰기 _는 모호하다).
_는 사용하지 않는다.
URI 경로에는 대문자 사용을 피하도록 규정하고 있다.

✅ Path parameter

해당 리소스에 더 자세한 정보를 얻기 위해 접근할 때 사용한다.

✅ Query parameter

웹 페이지의 url 주소를 자세히 보면 종종 ? 가 포함되어 있는데, 이 물음표 뒤에는 늘 key=value 형식의 문자열이 따라온다. 이를 Query parameter 라고 부른다. Query parameter는 주로 데이터를 조건으로 거르거나(filtering), 특정 방식으로 정렬하거나(sorting), 검색(searching)하고자 하는 경우에 활용된다.