RESTful API

Rookie·2022년 4월 29일
0

API 시스템을 구현하기 위한 아키텍처 중에 가장 널리 사용되는 형식

REST(REpresentational State Transfer)란 웹에 존재하는 모든 자원(resorce, ex. 이미지, 동영상, 데이터)에 고유한 URI를 부여하여 자원에 대한 주소를 지정하는 방법론, 또는 규칙입니다. 현재 가장 널리 사용되고 있습니다.

→ 즉 리소스 ( HTTP URL로 정의된)를 어떻게 한다 (HTTP Method + Payload)를 구조적으로 깔끔하게 표현

장점 : self - descriptiveness , rest ful api 그 자체 만으로도 api의 목적이 쉽게 이해된다.

단점: 표준규약이 없어 안티패턴으로 작성되는 경우가 흔하다.

안티패턴 → 실제 많이 사용되는 패턴이지만 비효율적이거나 비생산적인 패턴

  • URI 정보를 명확하게 표현해야 한다. ( ex. GET / user / 1 → GET / users/1)

  • resource에 대한 행위를 HTTP Method( GET,POST,PUT,DELETE)로 표현한다.

  • url에 http Method가 포함되서는 안된다.

  • URI에 동사가 포함되서는 안된다.

  • resource 사이에 연관 관계가 있는 경우 _ 리소스/고유id/관계 있는 리소스 (ex. GET/users/{user_id}/profile)

  • 파일의 경우 payload의 포맷을 나타내기 위한 파일 확장자를 uri에 포함시키지 않는다.

profile
노력형 잡캐입니다

0개의 댓글