API 명세서

 
scheme:[//[user[:password]@host[:port]][/path][?query][#fragment]
  • scheme : http 또는 https를 사용합니다.
  • user, password : 데이터가 있는 서버에 접근하기 위해 필요한 ID와 PASSWORD
  • host, port : 서버의 호스트와 포트 번호
  • path : 서버의 상세 경로
  • query : path에 접근하기 위한 추가 정보 (파라미터)
  • fragment : 메인 리소스 내에 존재하는 서브 리소스에 접근할 때 식별하기 위한 정보
RESTful한 API란 모든 리소스에 대해 고유한 URI를 부여하고 HTTP Method를 적절히 사용하여 리소스를 제어할 수 있는 수단입니다.
notion image

관계 나타내기

http://test.com/groups/1/users
  • groups, users : 이와 같이 복수로 표현되는 것들은 보통 여러 개의 리소스를 가질 수 있으므로 복수형으로 표시하고 ‘Collection’이라고 부릅니다.
  • 1 : Collection에 포함된 대상 리소스는 단수형으로 표시하고 ‘Document’라고 부릅니다.
  • /groups/1/users : Collection과 Document의 관계를 /를 통해 나타낼 수 있습니다. 그룹이라는 Collection 안에 ‘1’ Document를 나타내고, 해당 Document가 갖고 있는 사용자들을 나타냅니다.
notion image
  • GET : Query의 ‘SELECT’에 해당한다.
  • POST : Query의 ‘INSERT’에 해당한다.
  • PUT : Query의 ‘UPDATE’에 해당한다.
  • DELETE : Query의 ‘DELETE’에 해당한다.
notion image