RESTful API

Yujin·2023년 2월 3일
0
post-thumbnail

REST

Representational State Transfer, 상태 전달을 나타내는 방법
자원을 이름으로 구분하여 상태 및 정보를 주고 받는 행위

RESTful API
REST하게 API를 서술하는 방법

  • GET: 데이터 조회
  • POST: 데이터 추가, 생성
  • PUT: 데이터 전체 수정
  • DELETE: 데이터 삭제
  • HEAD: 리소스의 헤더. GET과 동일하지만 메시지 부분을 제외하고 상태 줄 및 헤더만 반환
  • OPTIONS: 리소스가 지원하고 있는 메소드 취득. 리소스에 대한 통신 가능 옵션(메소드)을 설명
  • PATCH: 리소스 부분 수정
  • CONNECT: 프록시 동작의 터널 접속을 변경. 대상 자원으로 식별되는 서버에 대한 터널을 설정

데이터 수 조절 (Pagination)

  • offset : 데이터 시작점
  • limit: 보여줄 개수
    ex. GET /products?offset=0&limit=100 : 0번 인덱스 부터 100개

path parameter과 query parameter

  • path parameter : 특정 리소스를 다룰 때
  • query parameter : url에서 특정한 조건을 주고싶을 때 사용. URL 끝에 물음표(?) 뒤에 위치하며 and 기호(&)로 구분된 이름=값 쌍으로 구성

    위 예시에서 path parameter(왼쪽)과 query parameter(오른쪽) 모두 동일한 결과를 불러온다. 특정 리소스 정보를 반환하는 API를 설계할 때는 path parameter가 query parameter 보다 적합하다.

0개의 댓글