REST API

정중식·2023년 1월 19일
0

기초

목록 보기
1/7

REST API

Representational State Transfer...

API란 무엇인가..

Application Programming interface의 약자로,
어떤식으로 통신할 수 있는지를 규약하는걸 뜻하는데,

웹 개발 환경에서의 API는 웹 서버와 고객간의 소통방법이라고 생각하면 되겠다.

그럼 API들을 어떤 식으로 만들어야 좋은 API일까?

이것에 대한 답이 바로, REST API 이다.
REST하게 API를 짜면 보기가 쉽고, 관리가 쉬워진다.

REST API 원칙 6개

1. Uniform interface

  • 하나의 자료는 하나의 URL로
  • URL 하나를 알면 둘을 알 수 있어야 함
  • 요청과 응답은 정보가 충분히 들어있어야 함
  1. Client-Server 역할 구분

    • 브라우저는 요청만 할 뿐
    • 서버는 응답만 할 뿐
  2. Stateless

    • 요청1과 요청2는 의존성이 없어야함 (독립적인 존재)
  3. Cacheable(브라우저가 알아서 잘해줌)

    • 서버에서 보내주는 정보들은 캐싱이 가능해야 함
    • 캐싱을 위한 버전 같은 것도 관리 잘해야함
  4. Layered Ststem

  5. Code on Demand

(5,6번은 중요하지않아서 따로 설명 뺌)

Uniform interface 예시

REST API에서 1번 원칙이 가장 중요하기에 예시를 들어봄

instagram.com/explore/tags/kpop
instagram.com/explore/tags/food
facebook.com/natgeo/photos
facebook.com/bbc/photos

좋은 REST API 이름짓기 원칙:

  • URL을 명사로 작성추천
  • 하위문서를 나타낼 땐 / 사용
  • 파일 확장자(.html)쓰지말기
    • 띄어쓰기는 대시(-) 이용
    • 자료 하나당 하나의 URL
profile
내 가치를 찾아서

0개의 댓글