RESTful API 란?

🌰 RESTful API란?

HTTP 통신에서 어떤 자원에 대한 CRUD 요청을 Resource와 Method로 표현하여 특정한 형태로 전달하는 방식

 

API 시스템을 구현하기 위한 아키텍처 중에 가장 널리 사용되는 형식.
HTTP method, URI, Resource로 이루어져 있다.

• URL(Uniform Resource Identifier)
  해당 사이트의 특정 자원의 위치를 나타내는 유일한 주소
• HTTP Method
  HTTP request가 의도하는 action을 정의한 것
• Payload
  HTTP request에서 server로 보내는 데이터 (body)

(위에 3가지는 이해 안가면 따로 학습해볼것!)

 

🥜 REpresentational State Transfer

웹상에서 사용되는 여러 리소스를 HTTP URI로 표현하고 그 리소스에 대한 행위를 HTTP Method로 정의하는 방식. 즉, 리소스(HTTP URI로 정의된)를 어떻게 한다(HTTP Method)를 구조적으로 깔끔하게 표현

 

🌰 RESTful API의 장점

🥜 Self-descriptiveness

RESTful API는 그 자체만으로도 API의 목적이 쉽게 이해가 된다.

 

🌰 RESTful API 설계 규칙

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

• resource는 명사를 사용한다.

🥜 resource에 대한 행위를 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

• URI에 HTTP Method가 포함되어서는 안된다.
• URI에 동사가 포함되서는 안된다.

🥜 resource 사이에 연관 관계가 있는 경우

• /리소스/고유ID/관계 있는 리소스

🥜 URI는 / 구분자를 사용하여 자원의 계층 관계를 나타내는데 사용한다.

🥜 URI 마지막 문자로 /를 포함하지 않는다.

🥜 불가피하게 URI가 길어지는 경우 -을 사용하여 가독성을 높인다.

🥜 _ 는 사용하지 않는다.

🥜 URI 경로에는 대문자 사용을 피하도록 규정하고 있다.

🥜 파일의 경우 payload의 포맷을 나타내기 위한 파일 확장자를 URI에 포함시키지 않는다.

 

🌰 Path parameters

필요한 상황에 따라, 내가 원하는 정보에 따라 URI를 다르게 요청할 수 있다.
원하는 조건의 데이터 또는 하나의 데이터에 대한 정보를 받아올 떄 사용한다.
Not Found시, 404 ERROR을 보낸다.

 

 

 

🌰 Query parameters

Path parameters보다 좀 더 상세조건으로 추출할 수 있다.
정렬이나 필터링을 할 때 사용한다.
Not Found시, 특정한 값을 보낸다.