[HTTP/네트워크] 실습

omegle·2022년 10월 6일
0

REST(Representational State Transfer) API

= 웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식

리차드슨의 REST 성숙도 모델(총 4단계-0~3단계)

  • 실제 3단계까지 엄밀히 지키기 어려워 2단계까지만 적용해도 좋은 API 디자인이라 할 수 있고 이를 HTTP API라고 부름
  • 0단계: HTTP 프로토콜을 사용하는 단계, REST API를 작성하기 위한 기본 단계임
  • 1단계: 개별 리소스와의 통신을 준수해야 함
    = 모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야 하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것
    = 어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요
    = 엔드포인트 작성 시에 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직함
    = 리소스 사용에 대한 성공/실패 여부를 포함한 응답을 해줘야 함.
  • 2단계: CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둠
    - HTTP 메서드를 사용할 때 몇가지 규칙
    = GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 함
    = POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환함. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 함. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 함
    = PUT 메서드와 PATCH 메서드도 구분하여 사용해야 함. PUT은 교체, PATCH는 수정의 용도로 사용합니다.

여기 2단계까지 적용하면 대체적으로 잘 작성된 API라고 함(HTTP API)

  • 3단계: HATEOAS(Hypertext As The Engine Of Application State)라는 하이퍼미디어 컨트롤을 적용
    : 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 함
    : 이때 링크 요소는 하이퍼미디어 컨트롤을 포함하고 있음

Open API

  • Open API는 외부 사이트와 자유롭게 활용 및 공유되도록 설계됨(YouTube, naver, kakao 등 여러 곳에서 open API를 제공함)
  • Open API라도 정해진 이용 수칙이 있고, 그에 따라 제한사항 (가격, 정보 등) 이 있을 수 있음(호출수에 따라 비용 발생 가능)

API Key

  • 말 그대로 API를 이용하기 위해 필요함. API key는 서버의 문을 여는 열쇠라고 할 수 있음.
  • API Key가 필요하면 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고 데이터를 요청할 때 API Key를 같이 전달해야 원하는 응답을 받을 수 있음
profile
JANG EUN JI | 장은지

1개의 댓글

comment-user-thumbnail
2022년 10월 6일

잘보고가욥 :D

답글 달기