Rest API, Restfull API 란

Narcoker·2023년 5월 16일
0

Web

목록 보기
1/11
post-custom-banner

Rest란

Representational State Transfer의 약자로
HTTP URI 에 자원을 명시하고,
HTTP Method(POST, GET, PUT, DELETE, PATCH 등)을 통해
해당 자원에 대한 CRUD Operation을 적용하는 것을 의미합니다.

CRUD Operation

CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인
Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말로
REST에서의 CRUD Operation 동작 예시는 다음과 같습니다.

  • Create : 데이터 생성(POST)
  • Read : 데이터 조회(GET)
  • Update : 데이터 수정(PUT, PATCH)
  • Delete : 데이터 삭제(DELETE)

[PUT과 PATCH의 차이]
PUT : 리소스의 모든 것을 업데이트 (덮어쓰기)
PATCH : 리소스의 일부를 업데이트 (속성변경)

Rest 구성요소

  • 자원(Resource) : HTTP URI
  • 자원에 대한 행위(Verb) : HTTP Method
  • 자원에 대한 행위의 내용 (Representations) : HTTP Message Payload

Rest의 특징

-Server-Client(서버-클라이언트 구조)

  • Stateless(무상태)
  • Cacheable(캐시 처리 가능)
  • Layered System(계층화)
  • Uniform Interface(인터페이스 일관성)

REST의 장단점

장점

  • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
  • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 준다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
  • Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
  • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
  • 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
    서버와 클라이언트의 역할을 명확하게 분리한다.

단점

  • 표준이 자체가 존재하지 않아 정의가 필요하다.
  • HTTP Method 형태가 제한적이다.
  • 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
  • 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어)

Rest API 설계 규칙REST API 설계 예시

URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.

Bad Example http://test.com/Running/
Good Example http://test.com/run/

마지막에 슬래시 (/)를 포함하지 않는다.

Bad Example http://test.com/test/
Good Example http://test.com/test

언더바 대신 하이폰을 사용한다.

URI에 밑줄이 있는 경우 가독성이 떨어지고
자바스크립트 내부 필드 접근자로 언더바를 사용하기 때문에 보안 이슈를 발생시킬 위험성이 있기 때문이다.

Bad Example http://test.com/test_blog
Good Example http://test.com/test-blog

파일확장자는 URI에 포함하지 않는다.

Bad Example http://test.com/photo.jpg
Good Example http://test.com/photo

행위를 포함하지 않는다.

HTTP Method가 행위를 나타내기 때문에 중복적으로 포함할 필요가 없다.

Bad Example http://test.com/delete-post/1
Good Example http://test.com/post/1

Restful API 란

Restful API이란 REST의 원리를 따르는 시스템을 의미합니다.
하지만 Rest를 사용했다 하여 모두가 Restful 한 것은 아닙니다.
REST API의 설계 규칙을 올바르게 지킨 시스템을 Restful하다 말할 수 있습니다

모든 CRUD 기능을 POST로 처리 하는 API,
혹은 URI 규칙을 올바르게 지키지 않은 API는
REST API의 설계 규칙을 올바르게 지키지 못한 시스템은 Rest API를 사용하였지만
Restful 하지 못한 시스템이라고 할 수 있습니다.

profile
열정, 끈기, 집념의 Frontend Developer
post-custom-banner

0개의 댓글