REST API

REST API

Representational State Transfer API
(상태를 전달하는 것을 나타내는 방법)
API를 작성하는 방식

설계 원칙

• URI는 동사를 제외한, 명사로 구성

• 동사의 의미는 html의 메소드(GET, POST, PUT, DELETE)를 사용

• Resource 사이에 연관 관계 및 계층 관계가 있으면 "/"를 사용

• URI의 마지막 문자로 "/"를 쓰지 않음

• URI가 길어지면 "-"를 사용

• 파일 확장자는 포함하지 않음

• 응답 response의 status code의 기본 규칙을 따름
  

Path parameter

특정 리소스르 가르키는 URI의 역활에 매개변수를 실제 값으로 대체하여 사용이 가능
POST, GET, PATCH, PUT, DELETE 등 모든 요청에 사용

https://map.naver.com/v5/entry/place/:placeId

https://map.naver.com/v5/entry/place/11583199
https://map.naver.com/v5/entry/place/1353885407
https://map.naver.com/v5/entry/place/12017005

Query Parameter

URL에서 특정한 조건을 주고 싶을 때 사용
GET, DELETE 요청에만 사용
필터링, 정렬, 데이터수 조절, 검색 등과 같은 경우에 자주 사용

https://github.com/orgs/wecode-bootcamp-korea/repositories?filtering-query-parameters

https://github.com/orgs/wecode-bootcamp-korea/repositories?q=&type=all&language=javascript&sort=stargazers

https://github.com/orgs/wecode-bootcamp-korea/repositories?q=&type=all&language=python&sort=stargazers