RESTful API

Junyoung Lee·2021년 7월 11일
1

RESTful API란?

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

URI?

  • Unifrom Resource Identifier
  • 해당 사이트의 특정 자원의 위치를 나타내는 유일한 주소
  • URL도 URI에 포함됨

HTTP Method

  • HTTP request가 의도하는 action을 정의한 것

Payload

  • HTTP request에서 server로 보내는 데이터 (body)

REST?

  • Repersentational State Transfer
  • 웹상에서 사용되는 여러 리소스를 HTTP URI로 표현하고 그 리소스에 대한 행위를 HTTP Method로 정의하는 방식. 즉 리소스를 어떻게 한다 를 구조적으로 깔끔하게 표현

RESTful API 설계 규칙

  • URI 정보를 명확하게 표현해야 한다
    resource는 명사를 사용한다
  • resource에 대한 행위를 HTTP Method로 표현
    • URI에 HTTP Method가 포함돼서는 안됨
    • URI에 동사가 포함돼서는 안됨
  • URI는 /구분자를 사용해서 자원의 계층 관계를 나타내는데 사용함
  • URI 마지막 문자로 /포함하지 않음
  • 불가피하게 길어지면 -를 사용하여 가독성을 높임
  • _는 사용하지 않음
  • 대문자 사용을 피해야함
  • 파일의 경우 확장자 포함하면 안됨, headers에 accept를 사용함

Query parameters

  • filtering, sorting, searching
    에러가 나면 안되는 곳에서 그냥 식별할 때 사용

profile
🎹재즈를 사랑하는 백엔드 개발자 이준영입니다🎷

0개의 댓글