Code Review

REST API 네이밍 기법

REST API 설계 원칙 중 API는 동사를 포함하지 않는 것이 권장되고 있다.

정리해보는 REST API 네이밍 기법

• URL은 정보의 자원을 표현해야 한다.

  • 동사보단 명사를 사용해야 한다
  • 대문자보단 소문자를 사용해야 한다
  • 컬렉션의 이름은 복수 명사를 사용해야 한다.

• URL에 HTTP Method가 포함되면 안된다.

• URL에 행위에 대한 동사 표현이 들어가면 안된다.

• '/' 는 계층 관계를 나타내는데 사용한다.

• URL 마지막 문자로 '/'를 사용하지 않는다.

• '_' 를 사용하지 않고 '-'를 사용하여 가독성을 높인다.

• 리소스 간에 연관 관계가 있는 경우 '/리소스명/리소스 ID/관계가 있는 다른 리소스명'

  GET : /books/{bookid}/viewers (일반적으로 소유 ‘has’의 관계를 표현할 때)

  이번에 리뷰 때 받은 수정 사항

PUT vs PATCH

PUT과 PATCH는 자원을 변경 할 때 사용되는 메소드이다.

PUT 같은 경우 존재하는 자원을 완전히 대체 할 때 사용이되고 없다면 새로 생성하고 201 응답값을 내려준다.

PATCH의 경우 존재하는 자원에 대해서 부분적으로 업데이트 하기 위해서 사용한다. 존재하지 않는 경우 에러를 발생시킨다.