URI 설계 패턴

URI란 무엇인가?

URI (Uniform Resource Identifier)
: 인터넷에서 특정 자원을 나타내는 주소 값, 해당 값은 유일하다.
URL (Uniform Resource Locator)
: 인터넷 상에서의 자원, 특정 파일이 어디에 위치하는지 식별하는 주소

URL은 URI의 하위 개념이다.

URI 설계 원칙 (RFC-3986)

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

해당 원칙을 사용하지 않는다고 해서 동작이 안되는 것은 아니다.