REST-API 리뷰

영태·2022년 8월 9일
RESTreview
0
post-thumbnail

REST API란?

API(Application Programming Interface)란?

  • 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것

REST의 정의

  • “Representational State Transfer” 의 약자
    • 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미합니다.
    • 즉, 자원(resource)의 표현(representation) 에 의한 상태 전달
      • 자원(resource)의 표현(representation)
        • 자원: 해당 소프트웨어가 관리하는 모든 것
          -> Ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
          자원의 표현: 그 자원을 표현하기 위한 이름
          -> Ex) DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정한다.
      • 상태(정보) 전달
        • 데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달
        • JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적
    • 월드 와이드 웹(www)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식
      • REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일입니다.
      • REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.

REST의 구체적인 개념

  • HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시
  • HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미합니다.
    • 즉, 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐입니다
    • 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여합니다

REST API의 특징

  • Server-Client(서버-클라이언트 구조)
    • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client
      • REST Server
        API를 제공하고 비즈니스 로직 처리 및 저장을 책임집니다.
      • REST Client
        사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임집니다.
    • 이를 통해 서로 간 의존성이 줄어듭니다.
  • Stateless(무상태)
    • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
    • Client의 context를 Server에 저장하지 않는다.
      • 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해집니다.

한편, TCP 프로토콜은 3-handshake를 맺고 서버가 클라이언트에 대한 정보와 상태를 유지시키고 있기 때문에 stateful하다고 합니다

  • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리합니다.
    • 각 API 서버는 Client의 요청만을 단순 처리
    • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안됨
    • 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용
    • Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아집니다
  • Cacheable(캐시 처리 가능)
    • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있습니다.
      • 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있습니다.
      • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능합니다.
    • 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있습니다.
  • Layered System(계층화)
    • Client는 REST API Server만 호출합니다.
    • REST Server는 다중 계층으로 구성될 수 있습니다.
      • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있습니다.
      • 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있습니다.
    • PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있습니다.
  • Uniform Interface(인터페이스 일관성)
    • URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행합니다.
    • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능합니다.
      • 특정 언어나 기술에 종속되지 않는다는 것입니다.
    • 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있습니다.
    • REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있습니다.
    • 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있습니다.
    • 이를 통해 MSA 구성에 용이합니다

REST의 장단점

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

Nestjs에서의 REST API 활용

개발 당시 기본적인 CRUD를 다음과 같이 구성했습니다

SNS 프로젝트에서 피드(게시글)에 관련된 API를 구성한 방식은 다음과 같습니다
0. controller에 다음과 같이 path를 'feed'로 설정해놓습니다

@Controller({ path: 'feed', version: 'v1' })
  1. create
  • 자원을 생성해야 하기에 post 메소드를 사용합니다
  • 생성할 게시글 내용을 body 파라미터로 둡니다
@Post()
createFeed(
    @CurrentUser() currentUser: ICurrentUser,
    @Body(ValidationPipe) createFeedInput: CreateFeedInput,
  ): Promise<Feed> {
    return this.feedService.create({ currentUser, createFeedInput });
  }
  1. update
  • 자원의 일부를 수정하는 상황이기에 patch 메소드를 사용합니다
  • 수정할 피드의 아이디를 패스 파라미터로 둡니다
  • 수정할 게시글 내용을 body 파라미터로 둡니다
@Patch(':feedId')
updateFeed(
    @CurrentUser() currentUser: ICurrentUser,
    @Param('feedId') feedId: number,
    @Body(ValidationPipe) updateFeedInput: UpdateFeedInput,
  ): Promise<Feed> {
    return this.feedService.update({ feedId, currentUser, updateFeedInput });
  }
  1. delete
  • 자원을 삭제하는 API이기에 delete 메소드를 사용합니다
  • 삭제할 피드의 아이디를 패스 파라미터로 둡니다
  • 다만, 이 api에서는 db상에서 soft-delete를 시키기 때문에 수정의 개념이므로 완전히 restful하진 않습니다
    • 단지 수정과 구분하기 위해 delete 메소드를 사용했습니다
@Delete(':feedId')
  async deleteFeed(
    @CurrentUser() currentUser: ICurrentUser,
    @Param('feedId') feedId: number,
  ): Promise<string> {
    const isDeleted: boolean = await this.feedService.delete({
      currentUser,
      feedId,
    });
    if (isDeleted) return ResponseType.feed.delete.msg;
    else throw new UnprocessableEntityException(ErrorType.feed.delete.msg);
  }
  1. restore
  • 자원을 복구하는 API인데 마땅한 메소드가 없어 전체 수정을 의미하는 put 메소드를 사용했습니다
  • 복구할 피드의 아이디를 패스 파라미터로 둡니다
  • 이 또한 완전히 restful하진 않습니다
    • 단지 구분을 위해 put을 사용했고 사용여부를 복구하는개념이기에 전체수정을 의미하는 put을 사용했는데 맞는건지는 모르겠습니다
    • delete와 put을 사용하는 것이 본질의 의미와는 상관없이 깔끔하겠다는 생각을 했습니다
    • Rest가 이 부분에 있어서는 확실히 메소드가 한정적이지 않나...라는 생각이 들었습니다
@Put(':feedId')
  async restoreFeed(
    @CurrentUser() currentUser: ICurrentUser,
    @Param('feedId') feedId: number,
  ) {
    const isRestored = await this.feedService.restore({ currentUser, feedId });
    if (isRestored) return ResponseType.feed.restore.msg;
    else throw new NotFoundException(ErrorType.feed.restore.msg);
  }
  1. read (fetch)
  • 자원을 조회하는 API이기에 get 메소드를 사용합니다
  • 조회할 피드의 아이디를 패스 파라미터로 둡니다
@Get(':feedId')
  fetchFeed(@Param('feedId') feedId: number): Promise<Feed> {
    return this.feedService.findOne({ feedId });
  }
  • 이외의 API
    • 피드 좋아요 API는 데이터 생성 개념 혹은 수정 개념이라 Post를 사용했습니다
    • 리스트 검색은 조회 개념이기에 Get을 사용했습니다

정리

Rest의 정의 및 구체적인 개념

  • 자원의 이름으로 구분하여 자원의 상태와 정보를 주고 받는 client-server 구조의 통신 아키텍처입니다
  • "representational state transfer"의 약자입니다
  • 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐입니다
  • 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여합니다

REST의 특징과 장점

  • 각각의 요청을 별개의 것으로 인식하고 처리합니다
  • HTTP 프로토콜을 그대로 사용합니다
    • 별도의 인프라 구축이 필요하지 않습니다
    • 가장 강력한 특징인 캐싱을 구현할 수 있습니다
      • 이를 통해 응답시간, 성능, 자원 이용률을 향상시킬 수 있습니다
      • 다중 계층으로 구성될 수 있습니다 따라서 이를 통해 로드밸런싱, 암호화, 인증 등의 계층을 추가해 구조상의 유연성을 줄 수 있으며 확장성과 보안성을 향상시킬 수 잇습니다
  • 프록시 서버, 게이트 웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있습니다
  • 서버와 클라이언트의 역할을 명확하게 분리합니다.
  • 가장 큰 특징은 인터페이스 일관성입니다
    • 통일되고 한정적인 인터페이스로 수정합니다
    • 따라서 높은 범용성을 보장하며
    • Http 표준을 따르는 모든 플랫폼에서 사용이 가능하기에 언어나 기술에 종속되지 않으며 이를 통해 MSA 구성에 용이합니다
  • Restful한 API는 의도하는 바를 쉽게 파악할 수 잇게 해줍니다
  • 서버와 클라이언트의 역할을 명확하게 분리합니다.

REST의 단점

  • 표준이 존재하지 않습니다
  • HTTP 메소드 형태가 제한적입니다
  • 구형 브라우저가 지원해주지 못하는 부분이 존재합니다
    • PUT, DELETE를 사용하지 못하는 점
    • pushState를 지원하지 않는 점
profile
영태
개발 공부중
이전 포스트

GraphQL & Apollo-Server 리뷰

다음 포스트

TypeORM 리뷰

0개의 댓글