[Web] URI 설계 패턴

URI 과 URL

URI(Uniform Resource Identifier)는 인터넷에 특정 자원을 나타내는 주소 값으로 해당 값을 유일하다. (응답을 달라질 수 있다.)

 

URL(Uniform Resource Locator)는 인터넷 상에서의 자원, 특정 파일이 어디에 위치하는지 식별하는 주소이다.

 

즉 URL은 URI의 하위 개념이다.

 

URI 설계 원칙 (RFC-3986)

• 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다.
• URI마지막 문자로 (/)는 포함하지 않는다.
• 하이픈(-)은 URI 가독성을 높이는데 사용한다.
• 밑줄(_)은 사용하지 않는다.
• URI 경로에는 소문자가 적합하다.
• 파일 확장자는 URI에 포함하지 않는다.
• 프로그래밍 언어에 의존적인 확장자를 사용하지 않는다.
• 구현에 의존적인 경로를 사용하지 않는다.
• 세션 ID를 포함하지 않는다.
• 프로그래밍 언어의 메소드명을 이용하지 않는다.
• 명사에 단수형보다는 복수형을 사용해야한다. 컬렉션에 대한 표현은 복수로 사용
• 컨트롤러 이름은 동사나 동사구로 표현한다.
• 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.
• CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.
• URI Query Parameter 디자인 -> URI 쿼리 부분으로 컬렉션 결과에 대해서 필터링 할 수 있다.
• URI 쿼리는 컬렉션의 결과를 페이지로 구분하여 나타내는데 사용한다.
• API에 있어서 서브 도메인은 일관성있게 사용해야한다.
• 클라이언트 개발자 포탈 서브 도메인은 일관성 있게 만든다.