본문 바로가기

Infrastructure/Network

[HTTP] 메서드 - 1 (API URI 설계)

좋은 API URL 설계에 대해서 알아본다.

먼저 Car라는 리소스에 대해서 URL을 설계해보자.

  • 회원 목록 조회: /read-car-list
  • 회원 조회: /read-car-by-id
  • 회원 등록: /create-car
  • 회원 수정: /update-car
  • 회원 삭제: /delete-car

과연 위의 설계가 좋은 설계일까?
결론은 그렇지않다. 아주 좋지 못한 설계다.
이유는 URL(Uniform Resource Identifier)의 의미를 다시 한 번 생각해보면 알 수 있다.

우리가 집중해야할 것은 car라는 리소스다.
create(생성), update(수정)이 아니라는 뜻이다.
그러므로 우리는 URL에 리소스가 아닌 정보를 포함하면 안된다.(물론 100% 사용하지 않고 개발 할 수는 없다.)

그러면 HTTP 메서드를 이용해서 URL에는 리소스만 포함되게 다시 한 번 API URL을 설계해보자.

  • 회원 목록 조회: GET /members
  • 회원 조회: GET /members/{id}
  • 회원 등록: POST /members/{id}
  • 회원 수정: PATCH /members/{id}
  • 회원 삭제: DELETE /members/{id}

아주 RESTful한 API URL이 작성되었다.

다음장부터는 위의 설계에서 사용한
GET, POST, PATCH, DELETE등 HTTP 메서드들에 대해서 하나씩 알아보도록 한다.

'Infrastructure > Network' 카테고리의 다른 글

[HTTP] 메서드 - 3 (속성)  (0) 2021.06.23
[HTTP] 메서드 - 2 (종류)  (0) 2021.06.23
[HTTP] 메시지 구조  (0) 2021.06.23
[HTTP] 기본  (0) 2021.06.22
[URI] URI와 WebBrowser  (0) 2021.06.22