RESTful API

limes·2020년 9월 29일
0
post-thumbnail

1. RESTful

  • REST(REpresentational State Transfer)란 웹에 존재하는 모든 자원(resorce, ex. 이미지, 동영상, 데이터)에 고유한 URI를 부여하여 자원에 대한 주소를 지정하는 방법론, 또는 규칙이며, 현재 가장 많이 사용되고 있다. 따라서, RESTful API는 REST 특징을 지키면서 API를 제공한다는 의미이다.

2. RESTful API

  • API의 엔드포인트 구조를 구현하는 방식
  • API에서 전송하는 자원(resource)을 URI로 표현하고 해당 자원에 행하고자 하는 의도를 HTTP 메소드로 정의
  • 각 앤드포인트는 리소스를 표현하는 고유의 URI 주소를 가지고 있으며,
    해당 리소스에 행할 수 있는 행위를 표현하는 HTTP 메소드를 처리할 수 있게 된다.

REST API의 파라미터에는 4가지 타입이 있다.

  • header 파라미터: 리퀘스트 헤더에 포함된 파라미터. 보통 인증 혹은 권한 부여에 관련되어 있다.
  • path 파라미터: 엔드포인트에서 쿼리문 이전의 파라미터.
  • query string 파라미터: 쿼리문 내의 파라미터. 엔드포인트가 끝난 뒤 물음표 뒤에 온다.
  • request body 파라미터: 리퀘스트 바디에 포함된 파라미터. 보통 JSON 형식으로 제출된다.

3. Path Parameter

  • 경로를 변수로서 사용하며, 각각의 게시물을 보기 위해서는 게시물의 id를 서버에 넘겨줘야 한다. 이를 Path Variable 를 사용하면 다음과 같다.
/post/6

4. Query String

  • Query Parameter 은 경로 뒤에 입력 데이터를 함께 제공하는 방법으로 사용한다.
/post?post_id=6
  • ? 뒤에 나오는 부분을 query string이라고 하며 뒤는 key, value의 쌍으로 이루어진다. 다음과 같이 &로 연결하여 여러 개의 데이터를 넘길 수도 있다.
/post?post_id=1&key1=value1

5. status code

0개의 댓글