웹 개발을 공부하면서 URI와 URL을 만나본 적이 있을 것이다. 본적이 없다면 새빨간 거짓말입니다😂 해당 포스팅에서는 URL과 URI가 어떻게 다른지, 어떻게 URI를 설계하는지에 대해서 알아보도록 하겠습니다.
1. URI (Uniform Resource Identifier)
- 인터넷에서 특정 자원을 나타내는 주소값이다. 해당 값은 유일하나, 응답은 달라질 수 있는 특징이 있다.
- Req: https://www.jennyfromdeblock.com/search/1
- Res: jennyfile.pdf
2. URL (Uniform Resource Locator)
- 인터넷 상에서의 자원, 특정 파일이 어디에 위치하는지 식별하는 주소
URL은 URI의 하위개념
💥 URI 설계 원칙
-
슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.
ex) http://localhost:8080/user/search -
URI 마지막 문자로(/)는 포함하지 않는다.
ex) http://localhost:8080/user/search/ <- 옳지않음 -
하이픈(-)은 URI 가독성을 높이는데 사용한다.
ex) http://localhost:8080/user/search/info-detail -
밑줄(_)은 사용하지 않는다.
ex) http://localhost:8080/user/search/info_detail -
URI 경로에는 소문자가 적합하다.
-
파일 확장자는 URI에 포함하지 않는다.
ex) http://localhost:8080/user-information.jsp -
프로그래밍 언어에 의존적인 확장자를 사용하지 않는다.
ex) http://localhost:8080/user/search/info-detail.do -
구현에 의존적인 경로를 사용하지 않는다.
ex) http://localhost:8080/servlet/classes/java -
세션 ID를 포함하지 않는다.
ex) http://localhost:8080/user/search/info?sesstion-id=random -
프로그래밍 언어의 Method 명을 이용하지 않는다
ex) http://localhost:8080/user/search/info?action=intro -
명사에 단수형 보다는 복수형을 사용해야 한다. 컬렉션에 대한 표현은 복수로 사용한다.
ex) http://localhost:8080/classes/examples/user-info -
컨트롤러 이름으로는 동사나 동사구를 사용한다
ex) http://localhost:8080/user/search -
경로 부분 중 변하는 부분은 유일한 값으로 대체한다.
ex) .../examples/lessons/{lesson-id}/users/{user-id}
ex) .../examples/lessons/2/users/434 -
CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.
ex) .../examples/lessons/2/users/READ -
URI Query Parameter 디자인 URI 쿼리 부분으로 컬렉션 결과에 대해서 필터링 할 수 있다.
-
URI 쿼리는 컬렉션의 결과를 페이지로 구분하여 나타내는데 사용한다.
-
API에 있어서 서브 도메인은 일관성 있게 사용해야 한다.
ex) https://google.com/
ex) https://api.google.com/
ex) https://api-google.com/ -
클라이언트 개발자 포탈 서브 도메인은 일관성 있게 만든다.
ex) http://dev-google.com/
컨트롤러에서 URI를 정하면서 중구난방으로 설정했던적도 많았고 이게 위배가 될까? 안될까? 하고 아리송했던 경험도 있다. 이렇게 URI 설계 원칙을 가볍게라도 읽어보고 최대한 지키면서 깔끔한 개발을 해보자😎
