RestFull API

정승렬·2022년 9월 10일
0

RestFull API의 의미

Representational State Transfer의 약자 이며
상태를 전달하는 것을 나타내는 방법
‘특정 자원(데이터)을 어떤 방식으로 전달하는 것’으로 간주하고, 이를 표현하는 방식을 통일하여, 개발자들 사이에서 의사소통을 원활히 하고자 해서 만든 약속

RestFull API의 장점

Self-descriptiveness
그 자체만으로 API의 목적을 나타냄

RestFUll API의 설계 원칙

  • URI는 동사를 제외한, 명사로 구성합니다.
  • Resource에 대한 행위를 HTTP method (GET, POST, PUT, DELETE)만으로 표현합니다.
  • Resource 사이에 연관 관계 및 계층 관계가 있는 경우 slash('/') 를 사용합니다.
    ex) [GET] /users/{user_id}/profile
  • URI 마지막 문자로 /를 포함하지 않습니다.
  • URI가 길어지는 경우 - 를 사용하여 가독성을 높입니다.
  • 파일 확장자는 URI에 포함시키지 않습니다. 이때, payload에 포함되는 파일의 확장자는 headers에 포함됩니다.
  • 응답 Response 의 status code의 기본적인 규칙을 따릅니다.

0개의 댓글