[CS/Programming] RESTful API / RESTful하게 API를 디자인 한다는 것

---

 

 

• RESTful API 

• RESTful API는 HTTP 통신을 REST 설계 규칙을 잘 지켜서 개발한 API를 RESTful한 API라고 합니다. 
• REST 설계 규칙은 URI는 정보의 자원만 표현해야 하며, 자원의 상태와 행위는 HTTP Method에 명시하는 걸 말합니다. 

 

---

 

 

• RESTful하게 API를 디자인한다는 것

 

RESTful하게 디자인한다는 것은 URI를 규칙에 맞게 잘 설계했는지의 여부입니다. 

 

1. 리소스와 행위를 명시적이고 직관적으로 분리합니다. 

• 리소스는 URI로 표현되는데 리소스가 가리키는 것은 명사로 표현되어야 합니다. 
• 행위는 HTTP Method로 표현하고, GET / POST / PUT / DELETE / PATCH 를 분명한 목적으로 사용합니다. 

 

2. Message는 Header와 Body를 명확하게 분리해서 사용합니다. 

• Entity에 대한 내용은 body에 담습니다. 
• 어플리케이션 서버가 행동할 판단의 근거가 되는 컨트롤 정보인 API 버전 정보, 응답받고자 하는 MIME 타입 등은 header에 담습니다. 
• header와 body는 http header와 http body로 나눌 수 있고, http body에 들어가는 json 구조로 분리할 수 있습니다. 

 

3. API 버전을 관리합니다. 

• 환경은 항상 변하기 때문에 API의 signature 가 변경될 수 있음에 유의합니다. 
•  특정 API를 변경할 때는 반드시 하위호환성을 보장해야 합니다. 

 

4. 서버와 클라이언트가 같은 방식을 사용해서 요청하도록 합니다. 

• 브라우저는 form-data 형식의 submit으로 보내고, 서버에서는 json 형태로 보내는 식의 분리보다는 json으로 보내든, 둘 다 form-data 형식으로 보내든 하나로 통일합니다. 
• 다른 말로 표현하자면 URI가 플랫폼 중립적이어야 합니다. 

 

 

---

 

* 위 글은 아래 문서를 참고해 작성했습니다. 

https://dev-coco.tistory.com/164

신입 개발자 기술면접 질문 정리 - 프로그래밍 공통/기타

https://github.com/JaeYeopHan/Interview_Question_for_Beginner/tree/main/Development_common_sense#restful-api

Interview_Question_for_Beginner/Development_common_sense at main · JaeYeopHan/Interview_Question_for_Beginner