본문 바로가기
TIL

Plmography 프로젝트 작업 로그 #6 - REST API 설계 (22.12.17 TIL)

by winteringg 2022. 12. 18.

F/E URL 설계를 끝내고 이제 REST API 를 설계할 예정인데, 설계에 앞서 REST API 특징에 관해 정리해보고자 글을 쓴다.

REST API 가장 큰 특징 두 가지는 URI 로 자원(리소스)을 요청하여 특정 형태로 표현한다는 것과, HTTP 메서드 (GET, POST 등) 를 적극적으로 활용하여 행위를 나타내야 한다는 점이다. 

예를 들어 GET /users 는 모든 user 의 정보를 응답으로 달라는 이야기이고, DELETE /user/1 은 userId: 1 에 해당하는 user 를 제거하라는 의미가 된다. 응답은 대체로 JSON 형태로 표현된다.

REST API 를 좀 더 RESTful 하게 표현하기 위한 규칙은 아래와 같다.

  • 마지막이 / (슬래시)로 끝나서는 안된다.
  • _(언더바) 대신 - (대쉬) 를 사용한다.
  • 소문자로 구성한다.
  • 동사는 포함하지 않고 HTTP 메서드로 대체한다
  • 파일 확장자를 표시하지 않는다.

하나부터 열까지 혼자서 기획하고 개발을 시작하려고 하니 중간 중간 막히는 부분이 많다. 이 과정을 반복하다보면 나중에는 익숙해져서 기계처럼 뚝딱 만들어 낼 수 있는 날이 오겠지? 잡생각 말고 다시 기획 마무리 하러 가보자!

댓글