TIL) RESTful API / Path Parameter & Query Parameter

Jiwon Lee·2022년 6월 13일
0

TIL

목록 보기
9/19

RESTful API (Representational State Transfer)

  • 두 컴퓨터 시스템이 인터넷을 통해 정보를 안전하게 교환하기 위해 사용하는 인터페이스이다.
    api에서 보내는 리소스를 URI로 표현하고, 해당 리소스에 대한 의도를 HTTP 메소드(GET, POST, PUT, PATCH, DELETE)를 사용하여 나타낸다.

Parmameter(매개변수)

함수 혹은 메서드 정의에서 나열되는 변수 명을 의미한다.

Path Parameter

path는 아마 urls.py 작성할 때 보았던 기억이 있을 것이다. url_pattern의 해당 API에 대한 엔드포인트를 지정해주는 것을 의미한다. 이것은 백엔드가 직접적으로 작성을 해야하는 부분이기에 꼭 필요한 부분이라고 볼 수 있다.

  • 데이터베이스의 특정 data를 가르킬 때 사용한다.
    ex) ...:8000:/products/1 -> 8000번 포트로 products의 id 값이 1번인 항목에 대한 요청.

Query Parameter

Query는 '질의'라는 뜻을 담고 있는데, Path Parameter에서 보내는 요청에서 보다 세밀한 정보들을 질문하는 경우라고 보면 될 것 같다. (때문에 "?"로 시작하는 걸까?)
그래서 filter의 느낌을 더 주며, 실제로 filtering, sorting, searching에 사용된다.

  • 모든 데이터는 string으로 들어가기 때문에, Query String이라고도 부른다.
  • key와 vlaue가 있는 형태이며, &로 key를 구분한다.
    ex) ...:8000/products?menu_id=1&color=red

0개의 댓글