REST API 란 뭘까..

동원·2022년 8월 29일
0

메모장

목록 보기
2/13

api를 제공해주면 그걸 사용을 해보기만 했지 api를 만든 경험은 없다.
회사에 다니면서 이번에 api를 만들어야 하는 과제가 생겼는데, 나처럼 아는 것 없는 개발자는 뭔가 항상 두렵다.

때문에 두렵지 않기 위해선 공부를 해야한다..

rest api가 무엇인지 검색을 해보았는데, 대부분 공통적으로 하는 글이 있었다.
REST API(RESTful API, 레스트풀 API)란 REST 아키텍처의 제약 조건을 준수하는 애플리케이션 프로그래밍 인터페이스를 뜻합니다. REST는 Representational State Transfer의 줄임말 입니다.

솔직하게 말하자면 무슨 소린지 잘 모르겠다..
나는 php로 API를 만들어야 하고, 내가 지금까지 API를 사용해본결과 ajax로 통신이 가능하다는 점과 어떨때는 CORS에 막혀 cross domain 설정을 해줘야한 다는 것의 경험이 쌓여있다. method론 CURD (GET, POST, DELETE, PATCH) 등이 있다.

이정도..?

그치만 이번 기회에 알고자 또 다시 찾아보기 귀찮기 때문에 적어 두려고 한다.
다음 글들은 어느 블로그를 통해 온전히 나의 단어장 역할으로 적어 두었다.

REST란
1. HTTP URL (Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고
2. HTTP Method(GET, POST, DELETE, PATCH)를 통해
3. 해당 자원(URL)에 대한 CURD operation을 적용하는 것을 의미

REST 구성요소
1. 자원(Resource) : HTTP URL
2. 자원에 대한 행위(Verb) : HTTP Method
3. 자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load

REST의 특징
1. Server-Client(서버-클라이언트 구조)
2. Stateless(무상태)
3. Cacheable(캐시 처리 가능)
4. Layered System(계층화)
5. Uniform Interface(인터페이스 일관성)

REST의 장단점
장점
1. HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
2. HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
3. HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
4. Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
5. REST API 메세지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악 할 수 있다.
6. 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
7. 서버와 클라이언트의 역할을 명확하게 분리한다.
단점
1. 표준이 자체가 존재하지 않아 정의가 필요하다.
2. HTTP Method 형태가 제한적이다.
3. 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL 보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
4. 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다. (익스플로러)

REST API란 REST의 원리를 따르는 API를 의미 하지만 REST API를 올바르게 설계하기 위해서는 지켜야하는 몇가지 규칙이 있으며 해당 규칙을 알아 보자

  1. URL는 동사보다는 명사를, 대분자보다는 소문자를 사용
Bad Example http://khj93.com/Running/
Good Example  http://khj93.com/run/  
  1. 마지막에 슬래시(/)를 포함하지 않는다.
Bad Example http://khj93.com/test/  
Good Example  http://khj93.com/test
  1. 언더바 대신 하이폰을 사용
Bad Example http://khj93.com/test_blog
Good Example  http://khj93.com/test-blog 
  1. 파일확장자는 URL에 포함하지 않는다.
Bad Example http://khj93.com/photo.jpg  
Good Example  http://khj93.com/photo  
  1. 행위를 포함하지 않는다.
Bad Example http://khj93.com/delete-post/1  
Good Example  http://khj93.com/post/1 

RESTful API란 REST의 원리를 따르는 시스템을 의미.
하지만 REST를 사용했다 하여 모두가 RESTful 한 것은 아님.
REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful 하다 말 할 수 있으며 모든 CRUD 기능을 POST로 처리하는 API 혹은 URL 규칙을 올바르게 지키지 않은 API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있다.

profile
동원이

0개의 댓글