[TIL]240703 REST API URI 작성 규칙

공부한 내용

REST API

• REST(Representational State Transfer)는 HTTP 네트워크 상의 리소스(Resource, 자원)를 정의하고 해당 리소스를 URI라는 고유한 주소로 접근하는 접근 방식을 의미하며, REST API란 REST 방식을 통해서 리소스에 접근하기 위한 서비스 API를 지칭한다.

REST에서 의미하는 리소스

• REST에서 의미하는 자원은 데이터베이스에 저장된 데이트, 문서, 이미지, 동영상 등 HTTP 통신을 통해 주고 받을 수 있는 모든 것을 의미한다.

URI(Uniform Resource Identifier)와 URL(Uniform Resource Locator)

• URI는 네트워크 상에 있는 특정 리소스를 식별하는 통합 자원 식별자(Uniform Resource Identifier)를 의미한다.
• URL은 인터넷에 있는 리소스를 나타내는 통합 리소스 식별자를 의미하며, 우리가 흔히들 이야기하는 웹 상의 주소를 의미한다.
• URI는 URL의 상위 개념으로 볼 수 있다.

REST API URI 작성 규칙

HTTP 상에서 REST API 서비스를 만드는 입장에서 REST API URI를 작성하는 규칙

URI 작성 기본 규칙

• URI의 마지막이 '/'로 끝나지 않아야 한다.
• 계층관계를 나타낼 때는 슬래시 구분자 사용한다.
• 동사 보다는 명사를 사용한다.
• 단수형 보다는 복수형 명사를 사용한다.
• URI는 기본 소문자로 사용한다.
• 언더스코어( _ ) 대신에 하이픈(-)을 사용한다.
• 파일 확장자는 URI에 포함하지 않는다.