[3주차 - DAY3] API

 

 

API

라이브러리에 접근하기 위한 규칙을 정의한 것이다. 

API 예시 - 날씨 정보

날씨 알림 어플을 만든다고 해보자. 날씨에 관련된 정보는 기상청이 가지고 있다. 하지만 우리는 기상청의 DB에 접근할 권한이 없기 때문에 기상청의 API를 통해 기상청에게 날씨 정보를 요청한다. API는 클라이언트와 서버의 중간에 위치하여 클라이언트와 서버를 중재하고, 매개체의 역할을 수행한다고 할 수 있다.

 

 

REST API 설계

URL

url은 웹 페이지의 위치를 알려주는 기능과 서버에 데이터를 연산해 달라고 요청을 보내는 기능도 수행한다.

ex) https://comic.naver.com/index

 

REST API

HTTP 통신 규약을 잘 따른 API를 의미한다. RESTful API는 REST 규칙을 잘 따르는 API를 말한다. RESTful API가 HTTP 규약을 더 잘 따른다고 생각하면 된다.

 

REST API URL 규칙

1. 소문자만 사용한다.
2. 하이픈(-)은 사용 가능하나, 언더바(_)는 사용하지 않는다.
3. 마지막에 '/'를 포함하지 않는다.
4. 행위(목적)를 포함하지 않는다. ex) get, post, delete 등
5. 파일 확장자를 포함하지 않는다.
6. 복수형을 사용한다.
   • 통일성
   • 많은 것들 중에서 하나를 선택하는 것이기 때문 ex) 상품"들" 중에서 특정 id 값을 가지는 개별 데이터 

 

설계 예시

상품 조회 화면

상품 상세 페이지

상품 관리 페이지

상품 수정 페이지

API	Method	URL
상품 전체 조회	GET	/products
상품 개별 조회	GET	/products/(id)
상품 개별 수정	PUT	/products/(id)