RESTful 한 API?

Merong·2022년 10월 4일
0

공부

목록 보기
3/3

Restful API

일단 API의 개념을 알아보자

  • API(Application Programming Interface) 응용 프로그램이
    사용할수 있도록 프로그래밍 언어가 제공하는 기능을 제어할수있게 만든
    인터페이스

  • API 는 UI와 비슷한 상호작용을 한다 서로다른 시스템이 만나 동작하기 위한
    의사소통 역할을 한다.

  • API의 접근 방식에는 크게 3가지가 존재
    Private API : API를 기업이나 연구 단체 등에서 사용하는 다양한 애플리케이션과 시
    스템의 통합을 위해 사용하는 것으로 단체 내부에서만 사용할 수 있도록 하는 것입니다.

    Partner API : API를 특정 비즈니스 파트너와 공유하는 것으로, 공유받은 API를 품질 저하 없이 사용할 수 있으며 수익 창출을 목표로 사용하는 것입니다.

    Public API : 모든 사람들에게 API를 제공하는 것으로, 개인이 API와 상호작용하는 프로그램을 무료로 개발할 수 있습니다. 다양한 아이디어를 통해 혁신적인 프로그램의 등장을 목표로 사용되고 있습니다.

    요정도로 정리해봤다

    그래서 RESTful 한 API는 뭐지?
    너무 깊이는 알아보지 않을거기 때문에 간단히 정리해 보겠다

    일단 검색을 해보니 REST api 디자인 가이드가 보인다
    여기서 하는말은


REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있습니다.

  • 첫 번째, URI는 정보의 자원을 표현해야 한다.
  • 두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

다른 것은 다 잊어도 위 내용은 꼭 기억해야한단다

그래서 URI는 뭔가

URI : 웹 기술에서 사용하는 논리적 또는 물리적 리소스를 식별하는 고유한 문자열 시퀀스다.

라고한다
1) URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용)

GET /members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 합니다. delete와 같은 행위에 대한 표현이 들어가서는 안됩니다.

2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현
위의 잘못 된 URI를 HTTP Method를 통해 수정해 보면

 DELETE /members/1

POST, GET, PUT, DELETE 이 4가지의 Method를 가지고 CRUD를 할 수 있습니다.

다음과 같은 식으로 URI는 자원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 하는 것이 REST한 API를 설계하는 중심 규칙입니다.

이정도로 간단히만 정리해봤다 끝.

출처 : https://meetup.toast.com/posts/92

0개의 댓글