REST API

티라노·2024년 12월 3일
0

Today I Learned

목록 보기
25/38

REST API란?

Representational State Tranfer API의 약자이다.

  • HTTP 프로토콜을 통해 서버의 리소스를 관리하는 HTTP 서버를 말한다.
  • URI로 데이터를 식별하고 HTTP의 메서드로 처리한다.

HTTP 요청 구조
[METHOD][URI][HTTP VERSION]
[HEADERS]
[BODY]

REST API에서 데이터 요청하는 방법

  1. URI
    접근할 데이터를 명시한다. (/member 등)

  2. Method
    리소스에 접근할 때 어떤 방식으로 접근할 것인지 정의한다.

    GET, POST, PUT, PATCH, DELETE 등
  3. Header
    요청할 때 추가로 필요한 정보

  4. Body
    요청할 때 전송해야하는 데이터

  5. HTTP 응답
    프로토콜에서 작업을 시도한 뒤 상태에 따라 응답 코드를 발신한다. 아래 사이트에서 다양한 코드와 의미를 찾아볼 수 있다.

    https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

웹 페이지에서 자주 보는 404, 504 에러가 바로 HTTP에서 발신한 코드이다.
지난 게시글에서는 데이터를 요청한 후 작업이 성공했을 때 식별하기 위해 응답 코드 200 을 사용했다.

REST API 환경 구성하기

Docker

Docker는 프로그램에 필요한 환경 구성 요소를 묶어서 제공하는 서비스이다.

서버를 열기 위해서는 다양한 프로그램이 필요한데, 그것을 모두 설치하고 세팅하다 보면 시간 낭비가 클 것이다. 이 때 Docker 이미지를 활용하면 프로그램을 실행하기 전에 필요한 준비 과정을 한 번에 마칠 수 있다.

Docker 사용법

  1. Docker를 설치한다.
    아래 URL은 Mac 환경 전용 설치 문서로 연결되기 때문에 윈도우는 docker install window를 검색해서 설치하자.

    https://docs.docker.com/desktop/setup/install/mac-install

  2. 사용하고자 하는 docker 이미지를 선택한다.
    docker hub에서 사용자들이 배포하는 컨테이너 이미지에 접근할 수 있다.

    https://hub.docker.com

원하는 이미지를 고르면 해당 페이지에서 pull 하는 명령어를 제공한다.
우선 pull로 이미지를 로컬에 당겨온다.

프로그램 종류에 따라서 이미지 실행 명령어를 제공하는 경우가 있다. 실행 명령어는 포트포워딩의 필요성 때문에 따로 제공하는 것으로, 이런 경우에는 이미지를 도커 프로그램에서 실행하지 말고 터미널에 해당 명령어를 입력하자.

0개의 댓글

관련 채용 정보