Rest API

김수람·2023년 1월 6일
0

REST의 정의

“Representational State Transfer” 의 약자

자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.

REST API는 HTTP 프로토콜을 기반으로하는 웹 서비스 아키텍처입니다. 자원, 메소드, 메시지 등을 정의하여 클라이언트-서버 간의 통신을 가능하게 합니다. 또한, RESTful API는 표준 HTTP 메소드(GET, POST, PUT, DELETE)를 사용하여 서버와 통신합니다

즉, 자원(resource)의 표현(representation) 에 의한 상태 전달

  • a) 자원(resource)의 표현(representation)
    자원: 해당 소프트웨어가 관리하는 모든 것
    -> Ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
    자원의 표현: 그 자원을 표현하기 위한 이름
    -> Ex) DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정한다.

  • b) 상태(정보) 전달
    데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다.
    JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

REST의 구체적인 개념

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.

  • 즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다.

  • 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

  • CRUD Operation
    Create : 생성(POST)
    Read : 조회(GET)
    Update : 수정(PUT)
    Delete : 삭제(DELETE)
    HEAD: header 정보 조회(HEAD)


REST 구성 요소

  1. 자원(Resource): URI
  • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
  • 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
  • Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

  1. 행위(Verb): HTTP Method
  • HTTP 프로토콜의 Method를 사용한다.
  • HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.

  1. 표현(Representation of Resource)
  • Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
  • REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.
  • JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

REST API의 개념

REST API란

API(Application Programming Interface)란

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

REST API의 정의

  • REST 기반으로 서비스 API를 구현한 것

  • 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.


REST API의 특징

  • 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.

  • REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.

  • 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.


REST API의 설계 규칙

  1. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
  • Ex) //restapi.example.com/houses/apartments

  1. URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
  • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
  • Ex) //restapi.example.com/houses/apartments/ (X)

  1. 하이픈(- )은 URI 가독성을 높이는데 사용
  • 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.

  1. 밑줄(_ )은 URI에 사용하지 않는다.
  • 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.

  1. URI 경로에는 소문자가 적합하다.
  • URI 경로에 대문자 사용은 피하도록 한다.
  • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문

  1. 파일확장자는 URI에 포함하지 않는다.
  • REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
  • Accept header를 사용한다.
  • Ex) //restapi.example.com/members/soccer/345/photo.jpg (X)
  • Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)

  1. 리소스 간에는 연관 관계가 있는 경우
  • /리소스명/리소스 ID/관계가 있는 다른 리소스명
  • Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

REST API와 RESTful API의 차이

  • RESTful은 REST의 설계 규칙을 잘 지켜서 설계된 API를 RESTful한 API라고 합니다.

  • 즉, REST의 원리를 잘 따르는 시스템을 RESTful이란 용어로 지칭됩니다.

URI와 URL의 차이

  • URI : Uniform Resource Locator로 인터넷 상 자원의 위치
  • URL : Uniform Resource Identifier로 인터넷 상의 자원을 식별하기 위한 문자열의 구성
    📍 URI는 URL을 포함함

REST API를 간단히 요약하면

  • URI는 정보의 자원만 표현해야 하며, 자원의 행위는 HTTP Method에 명시한다는 것입니다.
profile
프론트엔트 개발 꿈나무🍀

0개의 댓글