rhanziy

REST하게 API를 만들어? REST API 원칙 본문

study

REST하게 API를 만들어? REST API 원칙

rhanziy 2023. 1. 13. 16:31

API(Application Programming Interface) ?

명칭은 프로그램간의 통신규약을 뜻한다.

웹개발 환경에서 API는 웹서버와 고객간의 소통방법. 어떻게해야 서버랑 통신을 할 수 있을까?를 명시해놓은 규약

초기에 API는 일관성도 없고 지저분해보였기 때문에

HTTP 요청 시스템(GET, POST, PUT, DELETE)을 하나 짜놓고 쓰면 좋겠다~ 해서 만들어진 REST 원칙.

 

REST 원칙 6개

1. Uniform interface : 하나의 자료는 하나의 URL로 예측가능하게✨
2. Client-Server 역할의 구분 : 브라우저는 요청만하고 서버는 응답만 하게.
3. Stateless : 요청1과 요청2는 서로 독립적인 존재로 다루자.
4. Cacheable : 서버에서 보내주는 정보들은 캐싱이 가능해야한다.(브라우저가 알아서 해줌)
5. Layered System
6. Code on Demand  

 

원칙 1을 구현한 좋은 REST API 예시

www.example.com/products/66421

instagram.com/explore/tags/kpop/

facebook.com/natgeo/photos/

 

  • URl을 명사로 작성하자.
  • 하위 디렉토리를 나타낼 땐 / 
  • 파일확장자(.html) 쓰지말자.
  • 띄어쓰기는 대시(-) 이용
  • 자료하나당 하나의 URL

 

 

'study' 카테고리의 다른 글

Vue - v-if와 모달창 만들기  (0) 2023.06.18
Vue - 이벤트 핸들러 v-on, @click  (0) 2023.06.11
Vue - 데이터 바인딩과 v-for 반복문  (1) 2023.06.11
마크다운 문법 참고  (0) 2023.03.15
Vue 3버전 설치, 개발환경 셋팅  (0) 2023.02.01
Comments